locklib

Class LockGrantFuture<LockType>

java.lang.Object

locklib.LockGrantFuture<LockType>

Type Parameters:

LockType - the type of lock

All Implemented Interfaces:

Future<LockGrant<LockType>>

public class LockGrantFuture<LockType>
extends Object
implements Future<LockGrant<LockType>>

Future representing a request for a lock grant. This future object is created when requesting a lock on a target. A LockGrantFuture is an asynchronous request for a lock grant. A synchronous wait can be done invoking the get() or the get(long, TimeUnit) methods.

Lock grant futures can be cancelled. Cancelling a lock grant future will release any partial locks already acquired. It will not release the lock if it has already been acquired.

Synchronization locks on LockGrantFuture should never be made outside locklib

.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
LockGrant<LockType>	get()
LockGrant<LockType>	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
LockRequest<LockType>	request() Obtains the lock request.
Target<LockType>	target() Obtains the target of the lock.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<LockGrant<LockType>>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<LockGrant<LockType>>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<LockGrant<LockType>>

get

public LockGrant<LockType> get()
                        throws InterruptedException,
                               ExecutionException

Specified by:

get in interface Future<LockGrant<LockType>>

Throws:

InterruptedException

ExecutionException

get

public LockGrant<LockType> get(long timeout,
                               TimeUnit unit)
                        throws InterruptedException,
                               ExecutionException,
                               TimeoutException

Specified by:

get in interface Future<LockGrant<LockType>>

Throws:

InterruptedException

ExecutionException

TimeoutException

target

public Target<LockType> target()

Obtains the target of the lock.

Returns:

the target

request

public LockRequest<LockType> request()

Obtains the lock request.

Returns:

the lock request

toString

public String toString()

Overrides:

toString in class Object