com.tibco.as.space

Class PutOptions

java.lang.Object

com.tibco.as.space.PutOptions

All Implemented Interfaces:

SpaceOptions<PutOptions>

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

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

• Space.put(Tuple, PutOptions)
• Space.putAll(Collection, PutOptions)
• Space.compareAndPut(Tuple, Tuple, PutOptions)
• Space.compareAndPutAll(Collection, Collection, PutOptions)

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

Constructor Summary

Constructors

Constructor and Description
PutOptions()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	clone() Method to create a clone of this PutOptions object.
static PutOptions	create() Method used to instantiate an instance of a PutOptions object.
abstract java.lang.String	getFilter() Retrieve the filter that needs to be matched for the put to succeed
abstract long	getLockWait() Retrieve the current setting for the amount of time to wait for the lock on the key of an existing tuple.
abstract long	getTTL() Retrieve the current setting for the number of milliseconds to use as an entry's time to live.
abstract boolean	isForget() Retrieve whether tuples, which already exist in a space, should be returned as the return values of put operations, or whether the existing tuples should be "forgotten" and not returned.
abstract boolean	isLock() Retrieve whether or not to lock the key of a tuple after it is stored into the space.
abstract boolean	isRoute() Retrieve whether the put operation is routed.
abstract boolean	isUnlock() Retrieve whether or not to unlock the key of a tuple after it is stored into a space.
abstract PutOptions	setFilter(java.lang.String filter) Update the filter that would be matched for the put to succeed.
abstract PutOptions	setForget(boolean doForget) Specifies whether a tuple, which already exists in the space, should be returned as the return value of a put operation.
abstract PutOptions	setLock(boolean doLock) Specify whether or not to lock the key of a tuple after the tuple has been stored in a space.
abstract PutOptions	setLockWait(long lockWait) Specify the amount of time to wait to acquire the lock on the key of an existing tuple.
abstract PutOptions	setRoute(boolean doRoute) Specifies whether the put operation should be routed.
abstract PutOptions	setTTL(long ttl) Specify the time to live for entries stored into a space using this PutOptions object.
abstract PutOptions	setUnlock(boolean doUnlock) Specify whether or not to unlock the key after storing a tuple into 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

PutOptions

public PutOptions()

Method Detail

create

public static PutOptions create()

Method used to instantiate an instance of a PutOptions object.

Returns:

The newly created PutOptions 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 PutOptions setLockWait(long lockWait)

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

Parameters:

lockWait - Number of milliseconds to wait for a lock.

Returns:

The updated PutOptions object.

getLockWait

public abstract long getLockWait()

Retrieve the current setting for the amount of time to wait for the lock on the key of an existing tuple.

Returns:

Number of milliseconds to wait for a lock.

setLock

public abstract PutOptions setLock(boolean doLock)

Specify whether or not to lock the key of a tuple after the tuple has been stored in a space.

Parameters:

doLock - true - Lock the key if the put operation is successful. false - Do not lock the key.

Returns:

The updated PutOptions object.

isLock

public abstract boolean isLock()

Retrieve whether or not to lock the key of a tuple after it is stored into the space.

Returns:

true - The keys of any tuples stored with this PutOptions object will be locked after the tuples are stored in the space. false - The keys of any tuples put with this PutOptions object will not be locked after the tuples are stored in the space.

setUnlock

public abstract PutOptions setUnlock(boolean doUnlock)

Specify whether or not to unlock the key after storing a tuple into a space.

Parameters:

doUnlock - true - Unlock the key if the put is successful. false - Do not unlock the key after the put operation.

Returns:

The updated PutOptions object.

isUnlock

public abstract boolean isUnlock()

Retrieve whether or not to unlock the key of a tuple after it is stored into a space.

Returns:

true - Unlock the key if the put operation is successful. false - Do not unlock the key after the put operation.

setForget

public abstract PutOptions setForget(boolean doForget)

Specifies whether a tuple, which already exists in the space, should be returned as the return value of a put operation.

Parameters:

doForget - true - Do not return (forget) tuples which may already exist in the space. false - Return tuples which already exist in the space.

Returns:

The updated PutOptions object.

isForget

public abstract boolean isForget()

Retrieve whether tuples, which already exist in a space, should be returned as the return values of put operations, or whether the existing tuples should be "forgotten" and not returned.

Returns:

true - Forget tuples which already exist in the space. false - Do not forget tuples which already exist in the space, but return them as the return value of the put operation.

setRoute

public abstract PutOptions setRoute(boolean doRoute)

Specifies whether the put 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 put operation is routed.

Returns:

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

setTTL

public abstract PutOptions setTTL(long ttl)

Specify the time to live for entries stored into a space using this PutOptions object. WAIT_FOREVER means that an entry will never expire.

Parameters:

ttl - Time in milliseconds to use as an entry's time to live.

Returns:

The updated PutOptions object.

getTTL

public abstract long getTTL()

Retrieve the current setting for the number of milliseconds to use as an entry's time to live.

Returns:

The current time to live setting in milliseconds.

getFilter

public abstract java.lang.String getFilter()

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

Returns:

The current filter

setFilter

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

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

Parameters:

filter - The current filter

Returns:

The updated PutOptions object