oracle.jms
Class AQjmsTopicBrowser

java.lang.Object
oracle.jms.AQjmsObject
oracle.jms.AQjmsTopicBrowser

All Implemented Interfaces:

java.util.Enumeration, TopicBrowser

public class AQjmsTopicBrowser

extends oracle.jms.AQjmsObject

implements TopicBrowser, java.util.Enumeration

This is an Oracle class which implements javax.jms.TopicBrowser and java.util.Enumeration.

Method Summary

void	close() Since a provider may allocate some resources on behalf of a TopicBrowser outside the JVM, clients should close them when they are not needed.
java.util.Enumeration	getEnumeration() Gets an enumeration for browsing the current topic messages in the order they would be received.
java.lang.String	getMessageSelector() Gets this topic browser's message selector expression.
Topic	getTopic() Gets the topic associated with this topic browser.
java.lang.String	getTransformation() Gets this browser's transformation.
boolean	hasMoreElements() Tests if this enumeration contains more elements.
java.lang.Object	nextElement() Returns the next element of this enumeration.
void	purgeSeen() Purges messages seen so far during browse.
void	setTransformation(java.lang.String transformation) Sets this browser's transformation.

Methods inherited from class oracle.jms.AQjmsObject

checkClosed, children, finalize, getID, getParent, isOpen, localClose, preClose

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws JMSException

Description copied from interface: TopicBrowser

Since a provider may allocate some resources on behalf of a TopicBrowser outside the JVM, 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 TopicBrowser

Throws:

JMSException

getTopic

public Topic getTopic()
               throws JMSException

Gets the topic associated with this topic browser.

Specified by:

getTopic in interface TopicBrowser

Returns:

the topic

Throws:

JMSException - if the topic is not retrieved due to some error.

getEnumeration

public java.util.Enumeration getEnumeration()

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

If getEnumeration() is called twice on the same TopicBrowser, the same enumeration object is returned both times. Hence calling nextElement() on one enumeration object would modify the state of both enumeration objects.

Specified by:

getEnumeration in interface TopicBrowser

Returns:

an enumeration for browsing the messages

getMessageSelector

public java.lang.String getMessageSelector()
                                    throws JMSException

Gets this topic browser's message selector expression.

Specified by:

getMessageSelector in interface TopicBrowser

Returns:

this topic browser's message selector

Throws:

JMSException - if the message selector is not retrieved due to some error.

nextElement

public java.lang.Object nextElement()
                             throws java.util.NoSuchElementException

Returns the next element of this enumeration.

Attempts to use cached messages (if one is available from a previous call to hasMoreElements()). If the browser's selector used message ID, only one message can ever be returned during the browse; caches this state for subsequent calls.

Specified by:

nextElement in interface java.util.Enumeration

Returns:

the next element of this enumeration

Throws:

java.util.NoSuchElementException - if no more elements exist.

hasMoreElements

public boolean hasMoreElements()

Tests if this enumeration contains more elements.

Attempts to cach messages (for use by a subsequent call to nextElement()). If the browser's selector uses message ID, only one message can ever be returned during the browse; caches this state for subsequent calls.

Specified by:

hasMoreElements in interface java.util.Enumeration

Returns:

true if more elements exist in the enumeration, false otherwise

purgeSeen

public void purgeSeen()
               throws JMSException

Purges messages seen so far during browse. The purge will be finalized only when the session for the topic browse is committed.

Specified by:

purgeSeen in interface TopicBrowser

Throws:

JMSException - if an error occurs during the purge operation.

setTransformation

public void setTransformation(java.lang.String transformation)

Sets this browser's transformation. This transformation will be applied before the message is returned to the user.

Parameters:

transformation - the transformation to use when getting messages

getTransformation

public java.lang.String getTransformation()

Gets this browser's transformation.

Returns:

the transformation used when getting messages