com.tibco.as.space

Class TakeOptions

java.lang.Object

com.tibco.as.space.TakeOptions

All Implemented Interfaces:

SpaceOptions<TakeOptions>

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

TakeOptions allows you to specify custom lock wait/lock/unlock/forget options for performing take operations. TakeOptions is used as a parameter to the following methods of Space:

• Space.take(Tuple, TakeOptions)
• Space.takeAll(Collection, TakeOptions)
• Space.compareAndTake(Tuple, TakeOptions)
• Space.compareAndTakeAll(Collection, TakeOptions)

TakeOptions is an abstract class. To create an instance of TakeOptions, call create().

Constructor Summary

Constructors

Constructor and Description
TakeOptions()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	clone() Method to create a clone of this TakeOptions object.
static TakeOptions	create() Method used to instantiate an instance of a TakeOptions object.
abstract long	getLockWait() Retrieve the current setting for the amount of time a take operation should wait for the lock to be cleared on an existing locked tuple.
abstract boolean	isForget() Retrieve the current setting for whether or not to return the tuple taken from a space using this TakeOptions object.
abstract boolean	isLock() Retrieve the current setting for whether or not to lock the key of a tuple after it is removed from a space.
abstract boolean	isRoute() Retrieve whether the take operation is routed.
abstract boolean	isUnlock() Retrieve the current setting for whether or not to unlock the key of a tuple after it is removed from a space.
abstract TakeOptions	setForget(boolean doForget) Specify whether or not to return the tuple taken from a space using this TakeOptions object.
abstract TakeOptions	setLock(boolean doLock) Specify whether or not to lock the key of a tuple after it is removed from a space.
abstract TakeOptions	setLockWait(long lockWait) Specify the amount of time to wait to acquire the lock on an existing locked tuple.
abstract TakeOptions	setRoute(boolean doRoute) Specifies whether the take operation should be routed.
abstract TakeOptions	setUnlock(boolean doUnlock) Specify whether or not to unlock the key of a tuple after it is removed from a space.

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

TakeOptions

public TakeOptions()

Method Detail

create

public static TakeOptions create()

Method used to instantiate an instance of a TakeOptions object.

Returns:

The newly created TakeOptions object.

clone

public abstract java.lang.Object clone()

Method to create a clone of this TakeOptions object.

Overrides:

clone in class java.lang.Object

Returns:

The newly cloned TakeOptions object.

setLockWait

public abstract TakeOptions setLockWait(long lockWait)

Specify the amount of time to wait to acquire the lock on an existing locked tuple.

Parameters:

lockWait - Number of milliseconds to wait for a lock.

Returns:

The updated TakeOptions object.

setLock

public abstract TakeOptions setLock(boolean doLock)

Specify whether or not to lock the key of a tuple after it is removed from a space.

Parameters:

doLock - true - lock the key. false - do not lock the key.

Returns:

The updated TakeOptions object.

setUnlock

public abstract TakeOptions setUnlock(boolean doUnlock)

Specify whether or not to unlock the key of a tuple after it is removed from a space.

Parameters:

doUnlock - true - Unlock the key. false - Do not unlock they key.

Returns:

The updated TakeOptions object.

setForget

public abstract TakeOptions setForget(boolean doForget)

Specify whether or not to return the tuple taken from a space using this TakeOptions object.

Parameters:

doForget - true - Do not return the tuple taken from the space. false - Return the tuple taken from the space.

Returns:

The updated TakeOptions object.

getLockWait

public abstract long getLockWait()

Retrieve the current setting for the amount of time a take operation should wait for the lock to be cleared on an existing locked tuple.

Returns:

Number of milliseconds to wait for a lock.

isLock

public abstract boolean isLock()

Retrieve the current setting for whether or not to lock the key of a tuple after it is removed from a space.

Returns:

true - Lock the key. false - Do not lock the key.

isUnlock

public abstract boolean isUnlock()

Retrieve the current setting for whether or not to unlock the key of a tuple after it is removed from a space.

Returns:

true - Unlock the key. false - Do no unlock the key.

isForget

public abstract boolean isForget()

Retrieve the current setting for whether or not to return the tuple taken from a space using this TakeOptions object.

Returns:

true - Do not return the tuple. false - Return the "taken" tuple.

setRoute

public abstract TakeOptions setRoute(boolean doRoute)

Specifies whether the take operation should be routed.

Parameters:

doRoute - true - Route the operation. false - Do not route the operation.

Returns:

The updated PutOptions object.

isRoute

public abstract boolean isRoute()

Retrieve whether the take operation is routed.

Returns:

true - The operation is routed false - The operation is not routed, The operation is not sent to the "other cluster"