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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTOR_SEPARATOR
static final String	DELEGATION_ESCAPE
static final String	DELEGATION_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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
static String	buildDelegatedSource(@Nullable String originalSource, String bundle)	Utility method to build a delegated source string from an original source and a bundle
static String	buildDelegatedSource(@Nullable String originalSource, String bundle, @Nullable String actor)	Utility method to build a delegated source string from an original source, a bundle and an optional actor.
static String	buildSource(String bundle, @Nullable String actor)	Utility method to build a source string from a bundle and an optional actor.
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

Field Details

ACTOR_SEPARATOR

public static final String ACTOR_SEPARATOR

See Also:

• Constant Field Values

DELEGATION_SEPARATOR

public static final String DELEGATION_SEPARATOR

See Also:

• Constant Field Values

DELEGATION_ESCAPE

public static final String DELEGATION_ESCAPE

See Also:

• Constant Field Values

Constructor Details

AbstractEvent

protected 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

buildSource

public static String buildSource(String bundle,
 @Nullable String actor)

Utility method to build a source string from a bundle and an optional actor. Bundle names may not contain the actor separator. The actor, if present, will be replaced with `__` to disallow the delegation separator. Consequently, `__` will be doubled as an escape sequence.

Parameters:

bundle - the bundle (such as org.openhab.core.thing or org.openhab.binding.matter)

actor - the actor

Returns:

the final source string

buildDelegatedSource

public static String buildDelegatedSource(@Nullable String originalSource,
 String bundle)

Utility method to build a delegated source string from an original source and a bundle

Parameters:

originalSource - the original source (may be null)

bundle - the bundle (such as org.openhab.core.thing or org.openhab.binding.matter)

Returns:

the final source string

buildDelegatedSource

public static String buildDelegatedSource(@Nullable String originalSource,
 String bundle,
 @Nullable String actor)

Utility method to build a delegated source string from an original source, a bundle and an optional actor.

Parameters:

originalSource - the original source (may be null)

bundle - the bundle (such as org.openhab.core.thing or org.openhab.binding.matter)

actor - the actor

Returns:

the final source string