Package org.openhab.core.events

Class AbstractEvent

java.lang.Object

org.openhab.core.events.AbstractEvent

All Implemented Interfaces:

Event

Direct Known Subclasses:

AbstractInboxEvent, AbstractItemChannelLinkRegistryEvent, AbstractItemRegistryEvent, AbstractRuleRegistryEvent, AbstractThingRegistryEvent, AddonEvent, ChannelDescriptionChangedEvent, ChannelTriggeredEvent, ConfigStatusInfoEvent, ExecutionEvent, FirmwareStatusInfoEvent, FirmwareUpdateProgressInfoEvent, FirmwareUpdateResultInfoEvent, ItemEvent, RuleStatusInfoEvent, StartlevelEvent, ThingStatusInfoChangedEvent, ThingStatusInfoEvent, TimerEvent

@NonNullByDefault
public abstract class AbstractEvent
extends Object
implements Event

Abstract implementation of the Event interface.

Author:

Stefan Bußweiler - Initial contribution

Constructor Summary

Constructors

Constructor	Description
AbstractEvent(String topic, String payload, @Nullable String source)	Must be called in subclass constructor to create a new event.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
String	getPayload()	Gets the payload as a serialized string.
@Nullable String	getSource()	Gets the name of the source identifying the sender.
String	getTopic()	Gets the topic of an event.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openhab.core.events.Event

getType

Constructor Details

AbstractEvent

public AbstractEvent(String topic,
 String payload,
 @Nullable String source)

Must be called in subclass constructor to create a new event.

Parameters:

topic - the topic

payload - the payload

source - the source

Method Details

getTopic

public String getTopic()

Description copied from interface: Event

Gets the topic of an event.

Specified by:

getTopic in interface Event

Returns:

the event topic

getPayload

public String getPayload()

Description copied from interface: Event

Gets the payload as a serialized string.

Specified by:

getPayload in interface Event

Returns:

the serialized event

getSource

public @Nullable String getSource()

Description copied from interface: Event

Gets the name of the source identifying the sender.

Specified by:

getSource in interface Event

Returns:

the name of the source

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object