org.apache.activemq.broker.region.cursors
Interface PendingList

All Superinterfaces:

Iterable<MessageReference>

All Known Implementing Classes:

OrderedPendingList, PrioritizedPendingList

public interface PendingList
extends Iterable<MessageReference>

Method Summary

void	addAll(PendingList pendingList) Adds all the elements of the given PendingList to this PendingList.
PendingNode	addMessageFirst(MessageReference message) Adds the given message to the head of the list.
PendingNode	addMessageLast(MessageReference message) Adds the given message to the tail of the list.
void	clear() Discards all Messages currently held in the PendingList.
boolean	contains(MessageReference message) Query the PendingList to determine if the given message is contained within.
boolean	isEmpty() Returns true if there are no Messages in the PendingList currently.
Iterator<MessageReference>	iterator() Returns an iterator over the pending Messages.
PendingNode	remove(MessageReference message) Removes the given MessageReference from the PendingList if it is contained within.
int	size() Returns the number of MessageReferences that are awaiting dispatch.
Collection<MessageReference>	values() Returns a new Collection that contains all the MessageReferences currently held in this PendingList.

Method Detail

isEmpty

boolean isEmpty()

Returns true if there are no Messages in the PendingList currently.

Returns:

true if the PendingList is currently empty.

clear

void clear()

Discards all Messages currently held in the PendingList.

addMessageFirst

PendingNode addMessageFirst(MessageReference message)

Adds the given message to the head of the list.

Parameters:

message - The MessageReference that is to be added to this list.

Returns:

the PendingNode that contains the newly added message.

addMessageLast

PendingNode addMessageLast(MessageReference message)

Adds the given message to the tail of the list.

Parameters:

message - The MessageReference that is to be added to this list.

Returns:

the PendingNode that contains the newly added message.

remove

PendingNode remove(MessageReference message)

Removes the given MessageReference from the PendingList if it is contained within.

Parameters:

message - The MessageReference that is to be removed to this list.

Returns:

the PendingNode that contains the removed message or null if the message was not present in this list.

size

int size()

Returns the number of MessageReferences that are awaiting dispatch.

Returns:

current count of the pending messages.

iterator

Iterator<MessageReference> iterator()

Returns an iterator over the pending Messages. The subclass controls how the returned iterator actually traverses the list of pending messages allowing for the order to vary based on factors like Message priority or some other mechanism.

Specified by:

iterator in interface Iterable<MessageReference>

Returns:

an Iterator that returns MessageReferences contained in this list.

contains

boolean contains(MessageReference message)

Query the PendingList to determine if the given message is contained within.

Parameters:

message - The Message that is the target of this query.

Returns:

true if the MessageReference is contained in this list.

values

Collection<MessageReference> values()

Returns a new Collection that contains all the MessageReferences currently held in this PendingList. The elements of the list are ordered using the same rules as the subclass uses for iteration.

Returns:

a new Collection containing this lists MessageReferences.

addAll

void addAll(PendingList pendingList)

Adds all the elements of the given PendingList to this PendingList.

Parameters:

pendingList - The PendingList that is to be added to this collection.