org.objectweb.dream.queue
Interface MessageComparableKeyManager


public interface MessageComparableKeyManager

Calculates keys for messages. Keys are Comparable objects that can be used to order messages in a buffer.

See Also:
MessageKeyManager

Field Summary
static String ITF_NAME
          The commonly used name to refer to an interface with this signature.
 
Method Summary
 Comparable createComparableKey()
          Returns a new empty comparable key object.
 void deleteComparableKey(Comparable key)
          Delete the given comparable key instance.
 Comparable duplicateComparableKey(Comparable key)
          Clones the given comparable key.
 void fillComparableKey(Comparable key, Message message)
          Fills the given comparable key to match the given message.
 

Field Detail

ITF_NAME

static final String ITF_NAME
The commonly used name to refer to an interface with this signature.

See Also:
Constant Field Values
Method Detail

createComparableKey

Comparable createComparableKey()
Returns a new empty comparable key object.

Returns:
a new empty comparable key object; never null.

fillComparableKey

void fillComparableKey(Comparable key,
                       Message message)
Fills the given comparable key to match the given message.

Parameters:
key - the comparable key to calculate; must not be null.
message - the message to which the comparable key will be associated; must not be null

duplicateComparableKey

Comparable duplicateComparableKey(Comparable key)
Clones the given comparable key.

Parameters:
key - the comparable key to clone; never null.
Returns:
a clone of the given comparable key; never null.

deleteComparableKey

void deleteComparableKey(Comparable key)
Delete the given comparable key instance.

Parameters:
key - the comparable key to delete; never null.


Copyright © 2003, 2005 - INRIA Rhone-Alpes - All Rights Reserved.