com.tibco.as.space

Class UnlockOptions

java.lang.Object

com.tibco.as.space.UnlockOptions

All Implemented Interfaces:

SpaceOptions<UnlockOptions>

public abstract class UnlockOptions
extends java.lang.Object
implements SpaceOptions<UnlockOptions>

UnlockOptions implements the interface SpaceOptions and is used as a parameter to the following methods of Space:

• Space.unlock(Tuple, UnlockOptions)
• Space.unlockAll(java.util.Collection, UnlockOptions)

UnlockOptions can be used to specify a ResultHandler object or closure object when waiting asynchronously for a lock on a tuple, or collection of tuples, in a space. UnlockOptions is also used to specify the amount of time to wait for a lock to clear. UnlockOptions is an abstract class. To create an instance of UnlockOptions, call create().

Constructor Summary

Constructors

Constructor and Description
UnlockOptions()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	clone() Method to create a clone of this PutOptions object.
static UnlockOptions	create() Method used to instantiate an instance of an UnlockOptions object.
abstract long	getLockWait() Retrieves the current setting for the amount of time to wait for a lock to clear.
abstract UnlockOptions	setLockWait(long lockWait) setLockWait is used to set the amount of time to wait for a lock to clear.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tibco.as.space.SpaceOptions

getClosure, getResultHandler, setClosure, setResultHandler

Constructor Detail

UnlockOptions

public UnlockOptions()

Method Detail

create

public static UnlockOptions create()

Method used to instantiate an instance of an UnlockOptions object.

Returns:

The newly created UnlockOptions object.

clone

public abstract java.lang.Object clone()

Method to create a clone of this PutOptions object.

Overrides:

clone in class java.lang.Object

Returns:

The newly cloned PutOptions object.

setLockWait

public abstract UnlockOptions setLockWait(long lockWait)

setLockWait is used to set the amount of time to wait for a lock to clear.

Parameters:

lockWait - The amount of time in milliseconds to wait.

Returns:

The updated UnlockOptions object.

getLockWait

public abstract long getLockWait()

Retrieves the current setting for the amount of time to wait for a lock to clear.

Returns:

The amount of time in milliseconds to wait.