org.huihoo.jfox.ms.jms.queue
Class QueueBrowserImpl

java.lang.Object
  org.huihoo.jfox.ms.jms.queue.QueueBrowserImpl

All Implemented Interfaces:

javax.jms.QueueBrowser

public class QueueBrowserImpl

extends java.lang.Object

implements javax.jms.QueueBrowser

A client uses a QueueBrowser object to look at messages on a queue without removing them.

Version:

Revision: 1.1 Date: 2002-05-20 21:45:49

Author:

Peter.Cheng

Constructor Summary

QueueBrowserImpl()

Method Summary

void	close() Closes the QueueBrowser.
java.util.Enumeration	getEnumeration() Gets an enumeration for browsing the current queue messages in the order they would be received.
java.lang.String	getMessageSelector() Gets this queue browser's message selector expression.
javax.jms.Queue	getQueue() Gets the queue associated with this queue browser.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueBrowserImpl

public QueueBrowserImpl()

Method Detail

getQueue

public javax.jms.Queue getQueue()
                         throws javax.jms.JMSException

Gets the queue associated with this queue browser.

Specified by:

getQueue in interface javax.jms.QueueBrowser

Returns:

the queue

Throws:

javax.jms.JMSException - if the JMS provider fails to get the queue associated with this browser due to some internal error.

getMessageSelector

public java.lang.String getMessageSelector()
                                    throws javax.jms.JMSException

Gets this queue browser's message selector expression.

Specified by:

getMessageSelector in interface javax.jms.QueueBrowser

Returns:

this queue browser's message selector, or null if no message selector exists for the message consumer (that is, if the message selector was not set or was set to null or the empty string)

Throws:

javax.jms.JMSException - if the JMS provider fails to get the message selector for this browser due to some internal error.

getEnumeration

public java.util.Enumeration getEnumeration()
                                     throws javax.jms.JMSException

Gets an enumeration for browsing the current queue messages in the order they would be received.

Specified by:

getEnumeration in interface javax.jms.QueueBrowser

Returns:

an enumeration for browsing the messages

Throws:

javax.jms.JMSException - if the JMS provider fails to get the enumeration for this browser due to some internal error.

close

public void close()
           throws javax.jms.JMSException

Closes the QueueBrowser.

Since a provider may allocate some resources on behalf of a QueueBrowser outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

Specified by:

close in interface javax.jms.QueueBrowser

Throws:

javax.jms.JMSException - if the JMS provider fails to close this browser due to some internal error.