java.lang.Object
- com.tangosol.util.Base
- - com.tangosol.util.BitHelper
  - - com.tangosol.util.ExternalizableHelper
    - - com.tangosol.util.CompositeKey<P,S>

Type Parameters:

P - the type of the primary component

S - the type of the secondary component

All Implemented Interfaces:

Associated<P>, ExternalizableLite, PortableObject, KeyAssociation<P>, Serializable

Direct Known Subclasses:

SplitHttpSessionModel.ElasticKey
```
public class CompositeKey<P,S>
extends ExternalizableHelper
implements KeyAssociation<P>, 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

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.tangosol.util.ExternalizableHelper
  ExternalizableHelper.DecoratedMultiBufferReadBuffer, ExternalizableHelper.DefaultObjectStreamFactory, ExternalizableHelper.FormatAwareCompressor, ExternalizableHelper.IntDecoratedObject, ExternalizableHelper.Shielded, ExternalizableHelper.ShieldedDataOutputStream, ExternalizableHelper.ShieldedInputStream, ExternalizableHelper.ShieldedObjectOutputStream, ExternalizableHelper.ShieldedOutputStream, ExternalizableHelper.SimpleXmlBeanClassCache, ExternalizableHelper.Stats, ExternalizableHelper.XmlBeanClassCache
- Nested classes/interfaces inherited from class com.tangosol.util.Base
  Base.LoggingWriter

Field Summary
- Fields inherited from class com.tangosol.util.ExternalizableHelper
  BINARY_SIZE, CHUNK_SIZE, CHUNK_THRESHOLD, CONVERTER_FROM_BINARY, CONVERTER_STRIP_INTDECO, CONVERTER_TO_BINARY, DECO_APP_1, DECO_APP_2, DECO_APP_3, DECO_BACKUP, DECO_CUSTOM, DECO_EXPIRY, DECO_ID_MAX, DECO_ID_MIN, DECO_JCACHE, DECO_JCACHE_SYNTHETIC, DECO_MEMCACHED, DECO_PUSHREP, DECO_QUEUE_METADATA, DECO_RSVD_1, DECO_STORE, DECO_TOPLINK, DECO_TX, DECO_VALUE, DECO_WLS, EMPTY_BINARY_ARRAY, FMT_B_ARRAY, FMT_BIN_DECO, FMT_BIN_EXT_DECO, FMT_BINARY, FMT_BOOLEAN, FMT_BYTE, FMT_DECIMAL, FMT_DOUBLE, FMT_EXT, FMT_FLOAT, FMT_IDO, FMT_INT, FMT_INTEGER, FMT_LONG, FMT_NONE, FMT_NULL, FMT_OBJ_EXT, FMT_OBJ_SER, FMT_OPT, FMT_OPT_DOUBLE, FMT_OPT_INT, FMT_OPT_LONG, FMT_SHORT, FMT_STRING, FMT_UNKNOWN, FMT_XML_BEAN, FMT_XML_SER, FORCE_RESOLVING_STREAMS, LAMBDA_SERIALIZATION, MAX_DECO_HEADER_BYTES, PACKED_INT_SIZE, PACKED_LONG_SIZE, PROPERTY_CONFIG, s_streamfactory, TRINT_DOMAIN_SPAN, TRINT_MAX_VALUE, TRINT_MAX_VARIANCE, USE_POF_STREAMS, USE_XMLBEAN_CLASS_CACHE, XMLBEAN_CLASS_CACHE
- Fields inherited from class com.tangosol.util.Base
  LOG_ALWAYS, LOG_CONFIG, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors
Constructor	Description
`CompositeKey()`	Default constructor.
`CompositeKey(P primary, S secondary)`	Create a new CompositeKey that consists of the given primary and secondary components.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Indicates whether some other object is "equal to" this one.
`P`	`getAssociatedKey()`	Determine the host key (or base) object to which this object is associated.
`P`	`getPrimaryKey()`	Return the primary key component.
`S`	`getSecondaryKey()`	Return the secondary key component.
`int`	`hashCode()`	Returns a hash code value for this object.
`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()`	Returns a string representation of the object.
`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 com.tangosol.util.ExternalizableHelper
asBinary, calculatePackedLength, calculatePackedLength, checkObjectInputFilter, checkObjectInputFilter, checkObjectInputFilter, convertUTF, decodeExpiry, decorate, decorate, decorate, decorate, decorate, decorateBinary, encodeExpiry, ensureSerializer, extractIntDecoration, fromBinary, fromBinary, fromBinary, fromBinary, fromBinary, fromBinary, fromByteArray, fromByteArray, getClass, getConfigSerialFilter, getConfigSerialFilterFactory, getDecoration, getDecoration, getDecorations, getDeltaCompressor, getInputStream, getNewObjectInput, getObjectInput, getObjectInputFilter, getObjectOutput, getObjectStreamFactory, getOutputStream, getShieldedOutputStream, getStreamFormat, getUndecorated, getUndecorated, isDecorated, isDecorated, isIntDecorated, isIntDecorated, isResolving, isSerializable, isSerializerCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, loadClass, loadResource, main, makeTrint, readBigDecimal, readBigInteger, readBooleanArray, readBooleanArray, readByteArray, readCharArray, readCharArray, readCollection, readDate, readDoubleArray, readDoubleArray, readExternalizableLite, readExternalizableLite, readFloatArray, readFloatArray, readInt, readInt, readIntArray, readIntArray, readIntArray2d, readLargeBooleanArray, readLargeByteArray, readLargeCharArray, readLargeDoubleArray, readLargeFloatArray, readLargeIntArray, readLargeLongArray, readLargeObjectArray, readLargeStringArray, readLong, readLong, readLongArray, readLongArray, readMap, readMap, readObject, readObject, readObjectArray, readObjectArray, readSafeUTF, readSafeUTF, readSerializable, readSerializable, readStringArray, readStringArray, readTime, readTimestamp, readTrint, readUnsignedTrint, readUTF, readXmlBean, readXmlSerializable, readXmlSerializable, realize, removeIntDecoration, removeIntDecoration, replace, reportIncompatibleSerializers, setObjectStreamFactory, toBinary, toBinary, toBinary, toByteArray, toByteArray, toByteArray, toLiteBinary, toLong, undecorate, undecorate, validateBufferSize, validateLoadArray, validateLoadClass, writeBigDecimal, writeBigInteger, writeBooleanArray, writeByteArray, writeCollection, writeDate, writeDoubleArray, writeExternalizableLite, writeFloatArray, writeInt, writeInt, writeIntArray2d, writeLong, writeLong, writeMap, writeObject, writeSafeUTF, writeSafeUTF, writeSerializable, writeStringArray, writeTime, writeTimestamp, writeTrint, writeTrint, writeUTF, writeXmlBean, writeXmlSerializable

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, toBytes, toBytes, toBytes, toBytes, toInt, toInt, toLong

Methods inherited from class com.tangosol.util.Base
azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CompositeKey
```
public CompositeKey()
```
    Default constructor.
  - CompositeKey
```
public CompositeKey(P primary,
                    S secondary)
```
    Create a new CompositeKey that consists of the given primary and secondary components.
    
    Parameters:
    
    primary - the primary key component; must not be null. This is also the host key returned by the KeyAssociation implementation
    
    secondary - the secondary key component; must not be null
- Method Detail
  - getAssociatedKey
```
public P getAssociatedKey()
```
    Determine the host key (or base) object to which this object is associated.
    Note: It's expected that the returned object is suitable to be used as an immutable identity (e.g. a key in a Map).
    Note 2: Circular associations are not permitted.
    
    Specified by:
    
    getAssociatedKey in interface Associated<P>
    
    Returns:
    
    the host key that for this object, or null if this object has no association
  - 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
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
  - equals
```
public boolean equals(Object o)
```
    Indicates whether some other object is "equal to" this one.
    
    Overrides:
    
    equals in class Object
    
    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 String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - getPrimaryKey
```
public P getPrimaryKey()
```
    Return the primary key component.
    
    Returns:
    
    the primary key component
  - getSecondaryKey
```
public S getSecondaryKey()
```
    Return the secondary key component.
    
    Returns:
    
    the secondary key component

Class CompositeKey<P,​S>

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.ExternalizableHelper

Nested classes/interfaces inherited from class com.tangosol.util.Base

Field Summary

Fields inherited from class com.tangosol.util.ExternalizableHelper

Fields inherited from class com.tangosol.util.Base

Constructor Summary

Method Summary

Methods inherited from class com.tangosol.util.ExternalizableHelper

Methods inherited from class com.tangosol.util.BitHelper

Methods inherited from class com.tangosol.util.Base

Methods inherited from class java.lang.Object

Constructor Detail

CompositeKey

CompositeKey

Method Detail

getAssociatedKey

readExternal

writeExternal

readExternal

writeExternal

hashCode

equals

toString

getPrimaryKey

getSecondaryKey

Class CompositeKey<P,S>