AMETAS.util.context
Class AMETASMessageRetriever

java.lang.Object
  AMETAS.util.context.AMETASMessageRetriever

All Implemented Interfaces:

java.io.Serializable

public class AMETASMessageRetriever

extends java.lang.Object

implements java.io.Serializable

Retrieves messages from the mailbox. This enhances the standard retrieving mechanism.

Since:

2.6.0

See Also:

Serialized Form

Constructor Summary

AMETASMessageRetriever(AMETASPlaceUser pu)
Constructor.

AMETASMessageRetriever(AMETASPlaceUser pu, boolean bRecordMessageIDs)
Constructor.

AMETASMessageRetriever(AMETASPlaceUser pu, boolean bRecordMessageIDs, AMETASRetrievePolicy rp)
Constructor.

Method Summary

AMETASMessage	getNextMessage() Returns the next message.
AMETASMessage	getRecentMessage() Delivers the message most recently retrieved by getNextMessage.
boolean	pushbackLastMessage() Pushes back the recently retrieved message.
void	setRetrievePolicy(AMETASRetrievePolicy rp) Sets the retrieve policy for messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AMETASMessageRetriever

public AMETASMessageRetriever(AMETASPlaceUser pu)

Constructor. It is assumed that message IDs need not be stored.

Parameters:

pu - Reference to the Place User.

AMETASMessageRetriever

public AMETASMessageRetriever(AMETASPlaceUser pu,
                              boolean bRecordMessageIDs)

Constructor. It is assumed that message IDs need not be stored.

Parameters:

pu - Reference to the Place User.

bRecordMessageIDs - If true, the message IDs will be recorded so that multiple message reads (for undeletable messages) are avoided.

AMETASMessageRetriever

public AMETASMessageRetriever(AMETASPlaceUser pu,
                              boolean bRecordMessageIDs,
                              AMETASRetrievePolicy rp)

Constructor.

Parameters:

pu - Reference to the Place User.

bRecordMessageIDs - If true, the message IDs will be recorded so that multiple message reads (for undeletable messages) are avoided.

rp - Retrieve policy for getting messages.

Method Detail

setRetrievePolicy

public void setRetrievePolicy(AMETASRetrievePolicy rp)

Sets the retrieve policy for messages.

Parameters:

rp - Retrieve policy.

getNextMessage

public AMETASMessage getNextMessage()

Returns the next message. This depends of course on the set of actually incoming messages and the policy which of these messages is preferred.

Returns:

null if there is no new message, else the next message.

getRecentMessage

public AMETASMessage getRecentMessage()

Delivers the message most recently retrieved by getNextMessage.

Returns:

Recent message or null if no message has been retrieved yet.

pushbackLastMessage

public boolean pushbackLastMessage()

Pushes back the recently retrieved message.

Returns:

true if the message was pushed back successfully, else false. (May only happen if no messages have been retrieved yet.)