objects

Class PSTObject

java.lang.Object

objects.PSTObject

All Implemented Interfaces:

com.gemstone.gemfire.cache.util.ObjectSizer, com.gemstone.gemfire.DataSerializable, Serializable, objects.ConfigurableObject, TimestampedObject, UpdatableObject

Direct Known Subclasses:

DeltaPSTObject

public class PSTObject
extends Object
implements objects.ConfigurableObject, TimestampedObject, UpdatableObject, com.gemstone.gemfire.cache.util.ObjectSizer, com.gemstone.gemfire.DataSerializable

An object containing a timestamp, a byte array of configurable size and primitive fields.

Since:

5.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.gemstone.gemfire.DataSerializable

com.gemstone.gemfire.DataSerializable.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	byteArray
protected int	field1
protected char	field2
protected long	timestamp

Fields inherited from interface com.gemstone.gemfire.cache.util.ObjectSizer

DEFAULT, REFLECTION_SIZE, SIZE_CLASS_ONCE

Constructor Summary

Constructors

Constructor and Description
PSTObject()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Two PSTObjects are considered to be equal if they have the same values for field1, field2 and timestamp.
void	fromData(DataInput in)
int	getIndex() Returns the index encoded in the PSTObject's byte array.
long	getTimestamp() Returns the object creation timestamp encoded in the object.
int	hashCode()
void	incrementField1()
void	init(int index) Initializes a PSTObject.
void	resetTimestamp() Resets the timestamp encoded in the object to the current time.
int	sizeof(Object o)
void	toData(DataOutput out)
String	toString()
void	update() Updates one or more object fields.
void	validate(int index) Validates that the given index is encoded in the PSTObject's byte array.

Methods inherited from class java.lang.Object

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

Field Detail

timestamp

protected long timestamp

field1

protected int field1

field2

protected char field2

byteArray

protected byte[] byteArray

Constructor Detail

PSTObject

public PSTObject()

Method Detail

init

public void init(int index)

Initializes a PSTObject.

Specified by:

init in interface objects.ConfigurableObject

Parameters:

index - the value to encode into the PSTObject.

Throws:

ObjectCreationException - index cannot be encoded

getIndex

public int getIndex()

Returns the index encoded in the PSTObject's byte array.

Specified by:

getIndex in interface objects.ConfigurableObject

Throws:

ObjectAccessException

validate

public void validate(int index)

Validates that the given index is encoded in the PSTObject's byte array.

Specified by:

validate in interface objects.ConfigurableObject

Parameters:

index - the expected encoded value

Throws:

ObjectValidationException - If index is not encoded in bytes

incrementField1

public void incrementField1()

update

public void update()

Description copied from interface: UpdatableObject

Updates one or more object fields.

Specified by:

update in interface UpdatableObject

getTimestamp

public long getTimestamp()

Description copied from interface: TimestampedObject

Returns the object creation timestamp encoded in the object.

Specified by:

getTimestamp in interface TimestampedObject

resetTimestamp

public void resetTimestamp()

Description copied from interface: TimestampedObject

Resets the timestamp encoded in the object to the current time.

Specified by:

resetTimestamp in interface TimestampedObject

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Two PSTObjects are considered to be equal if they have the same values for field1, field2 and timestamp. This provides stronger validation than the validate(int) method that only considers the index.

Overrides:

equals in class Object

sizeof

public int sizeof(Object o)

Specified by:

sizeof in interface com.gemstone.gemfire.cache.util.ObjectSizer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toData

public void toData(DataOutput out)
            throws IOException

Specified by:

toData in interface com.gemstone.gemfire.DataSerializable

Throws:

IOException

fromData

public void fromData(DataInput in)
              throws IOException,
                     ClassNotFoundException

Specified by:

fromData in interface com.gemstone.gemfire.DataSerializable

Throws:

IOException

ClassNotFoundException