com.github.leanframeworks.minibus.base.topic

Class SimpleTopic<C>

java.lang.Object

com.github.leanframeworks.minibus.base.topic.SimpleTopic<C>

Type Parameters:

C - Type of content that can be sent on this topic.

All Implemented Interfaces:

Topic<C>

public class SimpleTopic<C>
extends Object
implements Topic<C>

Simple implementation of a topic that can be named (e.g. for logging and debugging purposes).

Note that two instances having the same contents will not be considered equal.

Constructor Summary

Constructors

Constructor and Description
SimpleTopic() Constructor.
SimpleTopic(String name) Constructor.
SimpleTopic(String name, Topic<? super C> parent) Constructor.
SimpleTopic(Topic<? super C> parent) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name of the topic (or topic instance), mostly useful for logging/debugging purposes.
Topic<? super C>	getParentTopic() Gets the parent topic if any.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.leanframeworks.minibus.api.Topic

covers

Constructor Detail

SimpleTopic

public SimpleTopic()

Constructor.

A unique name will be chosen.

SimpleTopic

public SimpleTopic(String name)

Constructor.

The specified name should either be unique or null. If it is null, a unique name will be chosen (different for each instance).

Parameters:

name - Unique name or null.

SimpleTopic

public SimpleTopic(Topic<? super C> parent)

Constructor.

Parameters:

parent - Parent topic covering this topic, or null.

SimpleTopic

public SimpleTopic(String name,
                   Topic<? super C> parent)

Constructor.

The specified name should either be unique or null. If it is null, a unique name will be chosen (different for each instance).

Parameters:

name - Unique name or null.

parent - Parent topic covering this topic, or null.

Method Detail

getName

public String getName()

Description copied from interface: Topic

Gets the name of the topic (or topic instance), mostly useful for logging/debugging purposes.

By default, the class's simple name followed by the instance's hash code.

Specified by:

getName in interface Topic<C>

Returns:

Topic name.

See Also:

Topic.getName()

getParentTopic

public Topic<? super C> getParentTopic()

Description copied from interface: Topic

Gets the parent topic if any.

A topic knows its parent, but a parent topic may or may not know their child topics depending on the implementation.

Specified by:

getParentTopic in interface Topic<C>

Returns:

Parent topic or null if this topic is a top-level topic.

See Also:

Topic.getParentTopic()

toString

public String toString()

Overrides:

toString in class Object