com.tibco.as.space

Class LockOptions

java.lang.Object

com.tibco.as.space.LockOptions

All Implemented Interfaces:

SpaceOptions<LockOptions>

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

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

• Space.lock(Tuple, LockOptions)
• Space.lockAll(java.util.Collection, LockOptions)

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

Constructor Summary

Constructors

Constructor and Description
LockOptions()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	clone() Method to create a clone of this LockOptions object.
static LockOptions	create() Method used to instantiate an instance of a LockOptions object.
abstract java.lang.String	getFilter() Retrieve the filter that needs to be matched for the lock to succeed
abstract long	getLockWait() Retrieve the current setting for the amount of time to wait to acquire the lock for a currently locked tuple.
abstract boolean	isForget() Retrieve the current setting for whether or not to return the tuple being locked.
abstract LockOptions	setFilter(java.lang.String filter) Update the filter that would be matched for the lock to succeed.
abstract LockOptions	setForget(boolean doForget) Specify whether or not to return the tuple being locked.
abstract LockOptions	setLockWait(long lockWait) Specify the amount of time to wait to acquire the lock for a tuple which is already locked.

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

LockOptions

public LockOptions()

Method Detail

create

public static LockOptions create()

Method used to instantiate an instance of a LockOptions object.

Returns:

The newly created LockOptions object.

clone

public abstract java.lang.Object clone()

Method to create a clone of this LockOptions object.

Overrides:

clone in class java.lang.Object

Returns:

The newly cloned LockOptions object.

setLockWait

public abstract LockOptions setLockWait(long lockWait)

Specify the amount of time to wait to acquire the lock for a tuple which is already locked.

Parameters:

lockWait - The amount of time, in milliseconds, to wait to lock a tuple.

Returns:

The updated LockOptions object.

setForget

public abstract LockOptions setForget(boolean doForget)

Specify whether or not to return the tuple being locked.

Parameters:

doForget - true - do not return the tuple being locked. false - return the tuple being locked.

Returns:

The updated LockOptions object.

getLockWait

public abstract long getLockWait()

Retrieve the current setting for the amount of time to wait to acquire the lock for a currently locked tuple.

Returns:

The amount of time, in milliseconds, to wait to acquire a lock.

isForget

public abstract boolean isForget()

Retrieve the current setting for whether or not to return the tuple being locked.

Returns:

true - do not return the tuple being locked. false - return the tuple being locked.

getFilter

public abstract java.lang.String getFilter()

Retrieve the filter that needs to be matched for the lock to succeed

Returns:

The current filter

setFilter

public abstract LockOptions setFilter(java.lang.String filter)

Update the filter that would be matched for the lock to succeed.

Parameters:

filter - The current filter

Returns:

The updated GetOptions object