Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


com.tangosol.util
Class CompositeKey

java.lang.Object
  extended by com.tangosol.util.Base
      extended by com.tangosol.util.BitHelper
          extended by com.tangosol.util.ExternalizableHelper
              extended by com.tangosol.util.CompositeKey

All Implemented Interfaces:
ExternalizableLite, PortableObject, KeyAssociation, java.io.Serializable

public class CompositeKey
extends ExternalizableHelper
implements KeyAssociation, ExternalizableLite, PortableObject

Key class that consists of a primary and secondary component. Two instances of CompositeKey are considered to be equal iff both the primary and secondary components of the two instances are considered equal. Additionally, the hash code of a CompositeKey takes into the consideration the hash codes of its two components. Finally, the CompositeKey class implements KeyAssociation by returning the primary component.

Author:
jh 2008.12.11

Constructor Summary
CompositeKey()
          Default constructor.
CompositeKey(java.lang.Object oPrimary, java.lang.Object oSecondary)
          Create a new CompositeKey that consists of the given primary and secondary components.

 

Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is "equal to" this one.
 java.lang.Object getAssociatedKey()
          Determine the key object to which this key object is associated.
 java.lang.Object getPrimaryKey()
          Return the primary key component.
 java.lang.Object getSecondaryKey()
          Return the secondary key component.
 int hashCode()
          Returns a hash code value for this object.
 void readExternal(java.io.DataInput in)
          Restore the contents of this object by loading the object's state from the passed DataInput object.
 void readExternal(PofReader in)
          Restore the contents of a user type instance by reading its state using the specified PofReader object.
 java.lang.String toString()
          Returns a string representation of the object.
 void writeExternal(java.io.DataOutput out)
          Save the contents of this object by storing the object's state into the passed DataOutput object.
 void writeExternal(PofWriter out)
          Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

 

Methods inherited from class com.tangosol.util.BitHelper
countBits, countBits, countBits, indexOfLSB, indexOfLSB, indexOfLSB, indexOfMSB, indexOfMSB, indexOfMSB, rotateLeft, rotateLeft, rotateLeft, rotateRight, rotateRight, rotateRight, toBitString, toBitString, toBitString

 

Constructor Detail

CompositeKey

public CompositeKey()
Default constructor.

CompositeKey

public CompositeKey(java.lang.Object oPrimary,
                    java.lang.Object oSecondary)
Create a new CompositeKey that consists of the given primary and secondary components.
Parameters:
oPrimary - the primary key component; must not be null. This is also the host key returned by the KeyAssociation implementation
oSecondary - the secondary key component; must not be null

Method Detail

getAssociatedKey

public java.lang.Object getAssociatedKey()
Determine the key object to which this key object is associated. The key object returned by this method is often referred to as a host key.
Specified by:
getAssociatedKey in interface KeyAssociation
Returns:
the host key that for this key object, or null if this key has no association

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.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:
java.io.IOException - if an I/O exception occurs
java.io.NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.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:
java.io.IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws java.io.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:
java.io.IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws java.io.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:
java.io.IOException - if an I/O error occurs

hashCode

public int hashCode()
Returns a hash code value for this object.
Returns:
a hash code value for this object.

equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is "equal to" this one.
Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.

toString

public java.lang.String toString()
Returns a string representation of the object.
Returns:
a string representation of the object.

getPrimaryKey

public java.lang.Object getPrimaryKey()
Return the primary key component.
Returns:
the primary key component

getSecondaryKey

public java.lang.Object getSecondaryKey()
Return the secondary key component.
Returns:
the secondary key component

Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


Copyright © 2000, 2009, Oracle. All rights reserved.