objects

Class BatchObject

java.lang.Object

objects.BatchObject

All Implemented Interfaces:

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

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

An object containing an index, a timestamp, a batch number such that the first BatchStringPrms.batchSize instances are in batch 0, the second are in batch 1, etc., and a byte array of size BatchObjectPrms.size.

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 inherited from interface com.gemstone.gemfire.cache.util.ObjectSizer

DEFAULT, REFLECTION_SIZE, SIZE_CLASS_ONCE

Constructor Summary

Constructors

Constructor and Description
BatchObject()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Two BatchObjects are considered to be equal if they have the same values for index, timestamp, and batch.
void	fromData(DataInput in)
int	getBatch() Returns the batch.
int	getIndex() Returns the index.
long	getTimestamp() Returns the object creation timestamp encoded in the object.
void	init(int anIndex) Initializes a BatchObject.
void	resetTimestamp() Resets the timestamp encoded in the object to the current time.
int	sizeof(Object o)
void	toData(DataOutput out)
String	toString()
void	validate(int anIndex) Validates that the given index is encoded in the BatchObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchObject

public BatchObject()

Method Detail

init

public void init(int anIndex)

Initializes a BatchObject.

Specified by:

init in interface objects.ConfigurableObject

Parameters:

index - the value to encode into the BatchObject.

Throws:

ObjectCreationException - index cannot be encoded

getIndex

public int getIndex()

Returns the index.

Specified by:

getIndex in interface objects.ConfigurableObject

getBatch

public int getBatch()

Returns the batch.

validate

public void validate(int anIndex)

Validates that the given index is encoded in the BatchObject.

Specified by:

validate in interface objects.ConfigurableObject

Parameters:

anIndex - the expected encoded value

Throws:

ObjectValidationException - If index is not the same as index

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 BatchObjects are considered to be equal if they have the same values for index, timestamp, and batch. 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

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