Package com.intellij.util.messages

Class Topic<L>

java.lang.Object

com.intellij.util.messages.Topic<L>

Type Parameters:

L - type of the interface that defines contract for working with the particular topic instance

public class Topic<L>
extends java.lang.Object

Defines messaging endpoint within particular bus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Topic.BroadcastDirection Message buses may be organised into hierarchies.

Constructor Summary

Constructors

Constructor and Description
Topic(java.lang.Class<L> listenerClass)
Topic(java.lang.Class<L> listenerClass, Topic.BroadcastDirection broadcastDirection)
Topic(java.lang.String displayName, java.lang.Class<L> listenerClass)
Topic(java.lang.String displayName, java.lang.Class<L> listenerClass, Topic.BroadcastDirection broadcastDirection)

Method Summary

Modifier and Type	Method and Description
static <L> Topic<L>	create(java.lang.String displayName, java.lang.Class<L> listenerClass)
static <L> Topic<L>	create(java.lang.String displayName, java.lang.Class<L> listenerClass, Topic.BroadcastDirection direction)
Topic.BroadcastDirection	getBroadcastDirection()
java.lang.String	getDisplayName()
java.lang.Class<L>	getListenerClass() Allows to retrieve class that defines contract for working with the current topic.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Topic

public Topic(java.lang.String displayName,
             java.lang.Class<L> listenerClass)

Topic

public Topic(java.lang.Class<L> listenerClass)

Topic

public Topic(java.lang.Class<L> listenerClass,
             Topic.BroadcastDirection broadcastDirection)

Topic

public Topic(java.lang.String displayName,
             java.lang.Class<L> listenerClass,
             Topic.BroadcastDirection broadcastDirection)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns:

human-readable name of the current topic. Is intended to be used in informational/logging purposes only

getListenerClass

public java.lang.Class<L> getListenerClass()

Allows to retrieve class that defines contract for working with the current topic. Either publishers or subscribers use it:

• publisher receives object that IS-A target interface from the messaging infrastructure. It calls target method with the target arguments on it then (method of the interface returned by the current method);
• the same method is called on handlers of all subscribers that should receive the message;

Returns:

class of the interface that defines contract for working with the current topic

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

public static <L> Topic<L> create(java.lang.String displayName,
                                  java.lang.Class<L> listenerClass)

create

public static <L> Topic<L> create(java.lang.String displayName,
                                  java.lang.Class<L> listenerClass,
                                  Topic.BroadcastDirection direction)

getBroadcastDirection

public Topic.BroadcastDirection getBroadcastDirection()

Returns:

broadcasting strategy configured for the current topic. Default value is Topic.BroadcastDirection.TO_CHILDREN

See Also:

Topic.BroadcastDirection