com.scaleout.client.caching

Class LockToken

java.lang.Object

com.scaleout.client.caching.LockToken

public abstract class LockToken
extends java.lang.Object

The LockToken is an identifier for a lock that is held on an object in the ScaleOut in-memory data grid.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_hasValue Flag to indicate if this lock token has a value.
protected int	_value The value of this lock token.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LockToken() Default constructor.

Method Summary

Modifier and Type	Method and Description
static LockToken	emptyLockToken() Retrieve an empty lock token.
boolean	hasValue() Check to see if this LockToken has a value.
int	value() Retrieve the LockToken value

Methods inherited from class java.lang.Object

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

Field Detail

_value

protected int _value

The value of this lock token.

_hasValue

protected boolean _hasValue

Flag to indicate if this lock token has a value.

Constructor Detail

LockToken

protected LockToken()

Default constructor.

Method Detail

value

public int value()

Retrieve the LockToken value

Returns:

the lock token

hasValue

public boolean hasValue()

Check to see if this LockToken has a value.

Returns:

true if the LockToken has a value, false if this LockToken has no value

emptyLockToken

public static LockToken emptyLockToken()

Retrieve an empty lock token.

Returns:

an empty lock token where hasValue() will always return false.