com.github.leanframeworks.minibus.api

Class Event<C>

java.lang.Object

com.github.leanframeworks.minibus.api.Event<C>

Type Parameters:

C - Type of content in the event.

public class Event<C>
extends Object

Entity holding the content that is published by publishers and received by event handlers.

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

Constructor Summary

Constructors

Constructor and Description
Event(Topic<? extends C> topic) Constructor specifying only the topic.
Event(Topic<? extends C> topic, C content) Constructor specifying the topic and content of the event.
Event(Topic<? extends C> topic, Channel channel, C content) Constructor specifying the topic, channel and content of the event.

Method Summary

Modifier and Type	Method and Description
Channel	getChannel() Gets the channel on which the event is being dispatched.
C	getContent() Gets the content of the event.
Topic<? extends C>	getTopic() Gets the topic of the event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(Topic<? extends C> topic)

Constructor specifying only the topic.

The content is null and sent on no particular channel.

Parameters:

topic - Topic for which the event is sent.

Event

public Event(Topic<? extends C> topic,
             C content)

Constructor specifying the topic and content of the event.

The content is sent on no particular channel.

Parameters:

topic - Topic for which the event is sent.

content - Content being sent.

Event

public Event(Topic<? extends C> topic,
             Channel channel,
             C content)

Constructor specifying the topic, channel and content of the event.

Parameters:

topic - Topic for which the event is sent.

channel - Channel on which the event is sent.

content - Content being sent.

Method Detail

getTopic

public Topic<? extends C> getTopic()

Gets the topic of the event.

Returns:

Event topic.

getChannel

public Channel getChannel()

Gets the channel on which the event is being dispatched.

Returns:

Channel on which the event is being dispatched.

getContent

public C getContent()

Gets the content of the event.

Returns:

Event content.

toString

public String toString()

Overrides:

toString in class Object