org.objectweb.dream.pushwithreturn
Class WaitingKey

java.lang.Object
  extended by org.objectweb.dream.pushwithreturn.WaitingKey
All Implemented Interfaces:
Recyclable

public class WaitingKey
extends Object
implements Recyclable

This class represents a waiting key. A waiting key stores data associated to a key: a message, a boolean indicating whether a returned message corresponding to the key has been received.


Constructor Summary
WaitingKey()
           
 
Method Summary
 Key getKey()
          Returns the key associated to this WaitingKey.
 Message getMessage()
          Returns the message associated to this key.
 Reference<? extends Recyclable> getReference()
           
 Message getReturnMessage()
          Returns the return message.
 boolean getReturnMessageReceived()
          Returns true if the return message has been received.
 void recycle()
           
 void setKey(Key key)
          Sets the key associated to this waiting key.
 void setMessage(Message message)
          Sets the message associated to this key.
 void setReference(Reference<? extends Recyclable> recyclableReference)
           
 void setReturnMessage(Message returnMessage)
          Sets the return message.
 void setReturnMessageReceived(boolean returnMessageReceived)
          Sets the returnMessageReceived boolean to the specifed value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WaitingKey

public WaitingKey()
Method Detail

getReturnMessage

public Message getReturnMessage()
Returns the return message.

Returns:
Returns the message.

setReturnMessage

public void setReturnMessage(Message returnMessage)
Sets the return message.

Parameters:
returnMessage - the return message to set.

setReturnMessageReceived

public void setReturnMessageReceived(boolean returnMessageReceived)
Sets the returnMessageReceived boolean to the specifed value.

Parameters:
returnMessageReceived - the value to set.

getReturnMessageReceived

public boolean getReturnMessageReceived()
Returns true if the return message has been received.

Returns:
true if the return message has been received.

setMessage

public void setMessage(Message message)
Sets the message associated to this key.

Parameters:
message - the message to be set.

getMessage

public Message getMessage()
Returns the message associated to this key.

Returns:
the message associated to this key.

setKey

public void setKey(Key key)
Sets the key associated to this waiting key.

Parameters:
key - the key to be set.

getKey

public Key getKey()
Returns the key associated to this WaitingKey.

Returns:
the key associated to this WaitingKey.

recycle

public void recycle()
Specified by:
recycle in interface Recyclable
See Also:
Recyclable.recycle()

getReference

public Reference<? extends Recyclable> getReference()
Specified by:
getReference in interface Recyclable
See Also:
Recyclable.getReference()

setReference

public void setReference(Reference<? extends Recyclable> recyclableReference)
Specified by:
setReference in interface Recyclable
See Also:
Recyclable.setReference(Reference)


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