org.vaadin.spring.events

Class Event<T>

java.lang.Object

org.vaadin.spring.events.Event<T>

All Implemented Interfaces:

Serializable

public class Event<T>
extends Object
implements Serializable

A class that represents an event that has been published on an EventBus.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

EventBus.publish(Object, Object), Serialized Form

Constructor Summary

Constructors

Constructor and Description
Event(EventBus eventBus, Object source, T payload)
Event(EventBus eventBus, Object source, T payload, String topic)

Method Summary

Modifier and Type	Method and Description
EventBus	getEventBus() Gets the event bus on which the event was originally published.
T	getPayload() Gets the payload of the event.
EventScope	getScope() Gets the scope of the event.
Object	getSource() Gets the object that published the event on the event bus.
long	getTimestamp() Gets the timestamp when the event was published on the event bus.
String	getTopic() Gets the string which specifies the topic of the event on the event bus.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(EventBus eventBus,
             Object source,
             T payload)

Event

public Event(EventBus eventBus,
             Object source,
             T payload,
             String topic)

Method Detail

getEventBus

public EventBus getEventBus()

Gets the event bus on which the event was originally published.

Returns:

the event bus, never null.

getScope

public EventScope getScope()

Gets the scope of the event.

Returns:

the scope, never null.

getSource

public Object getSource()

Gets the object that published the event on the event bus.

Returns:

the source of the event, never null.

getTopic

public String getTopic()

Gets the string which specifies the topic of the event on the event bus.

Returns:

the topic of the event, never null.

getTimestamp

public long getTimestamp()

Gets the timestamp when the event was published on the event bus.

Returns:

the timestamp.

getPayload

public T getPayload()

Gets the payload of the event.

Returns:

the payload, never null.

toString

public String toString()

Overrides:

toString in class Object