Package com.tangosol.net.partition

Class SimplePartitionKey

java.lang.Object

com.tangosol.net.partition.SimplePartitionKey

All Implemented Interfaces:

ExternalizableLite, PortableObject, KeyPartitioningStrategy.PartitionAwareKey, Serializable

public class SimplePartitionKey
extends Object
implements KeyPartitioningStrategy.PartitionAwareKey, ExternalizableLite, PortableObject

SimplePartitionKey is a trivial PartitionAwareKey implementation.

This key could also be used in conjunction with CompositeKey explicitly associate a partition with custom keys. For example:

 new CompositeKey(SimplePartitionKey.getPartitionKey(nPartition), oKeyNatural);
 

Since:

Coherence 3.7

Author:

rhl 2011.02.10

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_nPartition	The partition id.

Constructor Summary

Constructors

Modifier	Constructor	Description
	SimplePartitionKey()	Default constructor is defined for serialization purposes only.
protected	SimplePartitionKey(int nPartition)	Construct a SimplePartitionKey representing the specified partition.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getPartitionId()	Return the partition id that this key should be associated with.
static SimplePartitionKey	getPartitionKey(int nPartition)	Factory method for a SimplePartitionKey.
int	hashCode()
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
String	toString()
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

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

Field Detail

m_nPartition

protected int m_nPartition

The partition id.

Constructor Detail

SimplePartitionKey

public SimplePartitionKey()

Default constructor is defined for serialization purposes only. The getPartitionKey(int) factory method should be used to obtain a SimplePartitionKey.

SimplePartitionKey

protected SimplePartitionKey(int nPartition)

Construct a SimplePartitionKey representing the specified partition.

Parameters:

nPartition - the partition to create a key for

Method Detail

getPartitionKey

public static SimplePartitionKey getPartitionKey(int nPartition)

Factory method for a SimplePartitionKey.

Parameters:

nPartition - the partition to create a key for

Returns:

a SimplePartitionKey for the specified partition

getPartitionId

public int getPartitionId()

Return the partition id that this key should be associated with.

Specified by:

getPartitionId in interface KeyPartitioningStrategy.PartitionAwareKey

Returns:

the partition id that this key should be associated with

readExternal

public void readExternal(DataInput in)
                  throws IOException

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws IOException

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object