org.apache.qpid.jms.util

Class PriorityMessageQueue

java.lang.Object

org.apache.qpid.jms.util.AbstractMessageQueue

org.apache.qpid.jms.util.PriorityMessageQueue

All Implemented Interfaces:

MessageQueue

public final class PriorityMessageQueue
extends AbstractMessageQueue

Simple Message Priority ordered Queue. Message envelopes are stored in the Queue based on their priority value, except where enqueueFirst(org.apache.qpid.jms.message.JmsInboundMessageDispatch) is used.

Constructor Summary

Constructors

Constructor and Description
PriorityMessageQueue()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the Queue of any Messages.
void	enqueue(JmsInboundMessageDispatch envelope) Adds the given message envelope to the end of the Message queue.
void	enqueueFirst(JmsInboundMessageDispatch envelope) Adds the given message envelope to the front of the Message queue.
boolean	isEmpty()
protected JmsInboundMessageDispatch	peekFirst() Returns but does not remove the first entry in the implementation queue.
List<JmsInboundMessageDispatch>	removeAll() Removes and returns all Messages in the Queue.
protected JmsInboundMessageDispatch	removeFirst() Removes and returns the first entry in the implementation queue.
int	size() Returns the number of Messages currently in the Queue.

Methods inherited from class org.apache.qpid.jms.util.AbstractMessageQueue

close, dequeue, dequeueNoWait, getLock, isClosed, isRunning, peek, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

PriorityMessageQueue

public PriorityMessageQueue()

Method Detail

enqueue

public void enqueue(JmsInboundMessageDispatch envelope)

Description copied from interface: MessageQueue

Adds the given message envelope to the end of the Message queue.

Parameters:

envelope - The in-bound Message envelope to enqueue.

enqueueFirst

public void enqueueFirst(JmsInboundMessageDispatch envelope)

Description copied from interface: MessageQueue

Adds the given message envelope to the front of the Message queue.

Parameters:

envelope - The in-bound Message envelope to enqueue.

isEmpty

public boolean isEmpty()

Returns:

true if there are no messages in the queue.

size

public int size()

Description copied from interface: MessageQueue

Returns the number of Messages currently in the Queue. This value is only meaningful at the time of the call as the size of the Queue changes rapidly as Messages arrive and are consumed.

Returns:

the current number of Messages in the Queue.

clear

public void clear()

Description copied from interface: MessageQueue

Clears the Queue of any Messages.

removeAll

public List<JmsInboundMessageDispatch> removeAll()

Description copied from interface: MessageQueue

Removes and returns all Messages in the Queue.

Returns:

a List containing all Messages removed from the Queue.

removeFirst

protected JmsInboundMessageDispatch removeFirst()

Description copied from class: AbstractMessageQueue

Removes and returns the first entry in the implementation queue. This method is always called under lock and does not need to protect itself or check running state etc.

Specified by:

removeFirst in class AbstractMessageQueue

Returns:

the first message queued in the implemented queue.

peekFirst

protected JmsInboundMessageDispatch peekFirst()

Description copied from class: AbstractMessageQueue

Returns but does not remove the first entry in the implementation queue. This method is always called under lock and does not need to protect itself or check running state etc.

Specified by:

peekFirst in class AbstractMessageQueue

Returns:

the first message queued in the implemented queue.