com.persistit

Class ValueState

java.lang.Object

com.persistit.ValueState

All Implemented Interfaces:

Serializable

public class ValueState
extends Object
implements Serializable

Contains an immutable copy of the state from a Value object suitable for use as the key of a Map.

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ValueState(Value value) Construct an immutable ValueState by copying the relevant state information from a Value.
ValueState(Value value, int truncateSize) Construct an immutable ValueState by copying the relevant state information from a Value.

Method Summary

Modifier and Type	Method and Description
void	copyTo(Value value) Copies the content of this ValueState to the supplied Value.
boolean	equals(Object obj) Implements equals in such a way that Value and ValueState can be used interchangeably as map keys.
byte[]	getEncodedBytes()
int	getEncodedSize()
int	hashCode() The hash code for this ValueState.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ValueState

public ValueState(Value value)

Construct an immutable ValueState by copying the relevant state information from a Value. The hashCode and equals methods of Value and ValueState are compatible so that either a Value or a ValueState may be used as a map key.

Parameters:

value - The Value from which the state is copied.

ValueState

public ValueState(Value value,
                  int truncateSize)

Construct an immutable ValueState by copying the relevant state information from a Value. The hashCode and equals methods of Value and ValueState are compatible so that either a Value or a ValueState may be used as a map key. If the encoded size of the original value is larger than truncateSize, the result is truncated the that size.

Parameters:

value - The Value from which the state is copied.

truncateSize - Size at which the the copied encoded byte array is truncated.

Method Detail

copyTo

public void copyTo(Value value)

Copies the content of this ValueState to the supplied Value.

Parameters:

value - The Value to which content should be copied.

hashCode

public int hashCode()

The hash code for this ValueState. The hashCode is the same as for the equivalent Value, that is the Value from which this ValueState was constructed prior to any subsequent modifications.

Overrides:

hashCode in class Object

Returns:

The hashCode.

equals

public boolean equals(Object obj)

Implements equals in such a way that Value and ValueState can be used interchangeably as map keys.

Overrides:

equals in class Object

Returns:

true if the specified object is either a Value or a ValueState whose state represents an identical object or primitive value.

getEncodedBytes

public byte[] getEncodedBytes()

Returns:

the encoded byte array. See Value.getEncodedBytes().

getEncodedSize

public int getEncodedSize()

Returns:

the size of the encoded byte array. See Value.getEncodedSize().