Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Message Queue, v4.5 API Specification
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.jms
Interface Topic

All Superinterfaces:
  Destination

All Known Subinterfaces:
  TemporaryTopic

All Known Implementing Classes:
  BasicTopic, Topic

    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 API methods. For those methods that use a `Destination` as a parameter, a `Topic` object may used as an argument . For example, a Topic can be used to create a `MessageConsumer` and a `MessageProducer` by calling:

- `Session.CreateConsumer(Destination destination)`
- `Session.CreateProducer(Destination destination)`

Many publish/subscribe (pub/sub) providers group topics into hierarchies and provide various options for subscribing to parts of the hierarchy. The JMS API places no restriction on what a `Topic` object represents. It may be a leaf in a topic hierarchy, or it may 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. The JMS API 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:
  `Session.createConsumer(Destination)`, `Session.createProducer(Destination)`, `TopicSession.createTopic(String)`

Method Summary
`java.lang.String` | `getTopicName()` Gets the name of this topic.
`java.lang.String` | `toString()` Returns a string representation of this object.

Method Detail

### getTopicName

    java.lang.String getTopicName()
                                  throws JMSException

  Gets the name of this topic.

  Clients that depend upon the name are not portable.

  Returns:
    the topic name
  Throws:
    `JMSException` - if the JMS provider implementation of `Topic` fails to return the topic name due to some internal error.

### toString

    java.lang.String toString()

  Returns a string representation of this object.

  Overrides:
    `toString` in class `java.lang.Object`
  Returns:
    the provider-specific identity values for this topic

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Message Queue, v4.5 API Specification
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.