Package org.openhab.core.thing.events

Class ChannelDescriptionChangedEvent

java.lang.Object

org.openhab.core.events.AbstractEvent

org.openhab.core.thing.events.ChannelDescriptionChangedEvent

All Implemented Interfaces:

Event

@NonNullByDefault
public class ChannelDescriptionChangedEvent
extends AbstractEvent

ChannelDescriptionChangedEvents will be delivered through the openHAB event bus if the CommandDescription or StateDescription of a channel has changed. Instances must be created with the ThingEventFactory.

Author:

Christoph Weitkamp - Initial contribution

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChannelDescriptionChangedEvent.CommonChannelDescriptionField

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	The channel description changed event type.

Fields inherited from class org.openhab.core.events.AbstractEvent

ACTOR_SEPARATOR, DELEGATION_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChannelDescriptionChangedEvent(String topic, String payload, ChannelDescriptionChangedEvent.CommonChannelDescriptionField field, ChannelUID channelUID, Set<String> linkedItemNames, String value, @Nullable String oldValue)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ChannelUID	getChannelUID()	Gets the ChannelUID.
ChannelDescriptionChangedEvent.CommonChannelDescriptionField	getField()	Gets the changed field.
Set<String>	getLinkedItemNames()	Gets the linked item names.
@Nullable String	getOldValue()	Gets the old value (represented as JSON string).
String	getType()	Gets the event type.
String	getValue()	Gets the new value (represented as JSON string).
String	toString()

Methods inherited from class org.openhab.core.events.AbstractEvent

buildDelegatedSource, buildDelegatedSource, buildSource, equals, getPayload, getSource, getTopic, hashCode

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

The channel description changed event type.

Constructor Details

ChannelDescriptionChangedEvent

protected ChannelDescriptionChangedEvent(String topic,
 String payload,
 ChannelDescriptionChangedEvent.CommonChannelDescriptionField field,
 ChannelUID channelUID,
 Set<String> linkedItemNames,
 String value,
 @Nullable String oldValue)

Creates a new instance.

Parameters:

topic - the topic

payload - the payload

field - the changed field

channelUID - the ChannelUID

linkedItemNames - a Set of linked item names

value - the new value (represented as JSON string)

oldValue - the old value represented as JSON string)

Method Details

getType

public String getType()

Description copied from interface: Event

Gets the event type.

Returns:

the event type

getField

public ChannelDescriptionChangedEvent.CommonChannelDescriptionField getField()

Gets the changed field.

Returns:

the changed field

getChannelUID

public ChannelUID getChannelUID()

Gets the ChannelUID.

Returns:

the ChannelUID

getLinkedItemNames

public Set<String> getLinkedItemNames()

Gets the linked item names.

Returns:

a Set of linked item names

getValue

public String getValue()

Gets the new value (represented as JSON string).

Returns:

the new value.

getOldValue

public @Nullable String getOldValue()

Gets the old value (represented as JSON string).

Returns:

the old value.

toString

public String toString()

Overrides:

toString in class Object