org.objectweb.dream.queue
Interface MessageKeyManager


public interface MessageKeyManager

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


Field Summary
static String ITF_NAME
          The commonly used name to refer to an interface with this signature.
 
Method Summary
 Object createKey()
          Returns a new empty key object.
 void deleteKey(Object key)
          Delete the given key instance.
 Object duplicateKey(Object key)
          Clones the given key.
 void fillKey(Object key, Message message)
          Fills the given 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

createKey

Object createKey()
Returns a new empty key object.

Returns:
a new empty key object; never null.

fillKey

void fillKey(Object key,
             Message message)
Fills the given key to match the given message.

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

duplicateKey

Object duplicateKey(Object key)
Clones the given key.

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

deleteKey

void deleteKey(Object key)
Delete the given key instance.

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


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