javax.jms
Interface Topic

All Known Subinterfaces:

TemporaryTopic

public interface Topic

extends Destination

A Topic object encapsulates a provider-specific topic name. It is the way a client specifies the identity of a topic to JMS methods.

Many Pub/Sub providers group topics into hierarchies and provide various options for subscribing to parts of the hierarchy. JMS places no restriction on what a Topic object represents. It might be a leaf in a topic hierarchy or it might be a larger part of the hierarchy.

The organization of topics and the granularity of subscriptions to them is an important part of a Pub/Sub application's architecture. JMS does not specify a policy for how this should be done. If an application takes advantage of a provider-specific topic grouping mechanism, it should document this. If the application is installed using a different provider, it is the job of the administrator to construct an equivalent topic architecture and create equivalent Topic objects.

See Also:

TopicSession.createTopic(String)

Method Summary

java.lang.String	getTopicName() Get the name of this topic.
java.lang.String	toString() Return a pretty printed version of the topic name.

Method Detail

getTopicName

public java.lang.String getTopicName()
                              throws JMSException

Get the name of this topic.

Clients that depend upon the name, are not portable.

Returns:

the topic name

Throws:

JMSException - if JMS implementation for Topic fails to to return topic name due to some internal error.

toString

public java.lang.String toString()

Return a pretty printed version of the topic name.

Overrides:

toString in class java.lang.Object

Returns:

the provider specific identity values for this topic.