Package org.openhab.core.thing.events

Class ThingEventFactory

java.lang.Object

org.openhab.core.events.AbstractEventFactory

org.openhab.core.thing.events.ThingEventFactory

All Implemented Interfaces:

EventFactory

@NonNullByDefault
public class ThingEventFactory
extends AbstractEventFactory

A ThingEventFactory is responsible for creating thing event instances:

• ThingStatusInfoEvent.TYPE

Author:

Stefan Bußweiler - Initial contribution, Dennis Nobel - Added status changed event, Christoph Weitkamp - Added ChannelDescriptionChangedEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThingEventFactory.ChannelDescriptionChangedEventPayloadBean
static class	ThingEventFactory.ChannelDescriptionCommandOptionsPayloadBean
static class	ThingEventFactory.ChannelDescriptionPatternPayloadBean
static class	ThingEventFactory.ChannelDescriptionStateOptionsPayloadBean
static interface	ThingEventFactory.CommonChannelDescriptionFieldPayloadBean
static class	ThingEventFactory.TriggerEventPayloadBean	This is a java bean that is used to serialize/deserialize trigger event payload.

Constructor Summary

Constructors

Constructor	Description
ThingEventFactory()	Constructs a new ThingEventFactory.

Method Summary

Modifier and Type	Method	Description
static ThingAddedEvent	createAddedEvent(Thing thing)	Creates a thing added event.
static ChannelDescriptionChangedEvent	createChannelDescriptionChangedEvent(ChannelUID channelUID, Set<String> linkedItemNames, StateDescriptionFragment stateDescription, @Nullable StateDescriptionFragment oldStateDescription)	Creates a ChannelDescriptionChangedEvent for a changed StateDescription.
static ChannelDescriptionChangedEvent	createChannelDescriptionCommandOptionsChangedEvent(ChannelUID channelUID, Set<String> linkedItemNames, List<CommandOption> options, @Nullable List<CommandOption> oldOptions)	Creates a ChannelDescriptionChangedEvent for change CommandOptions.
static ChannelDescriptionChangedEvent	createChannelDescriptionPatternChangedEvent(ChannelUID channelUID, Set<String> linkedItemNames, String pattern, @Nullable String oldPattern)	Creates a ChannelDescriptionChangedEvent for a changed pattern.
static ChannelDescriptionChangedEvent	createChannelDescriptionStateOptionsChangedEvent(ChannelUID channelUID, Set<String> linkedItemNames, List<StateOption> options, @Nullable List<StateOption> oldOptions)	Creates a ChannelDescriptionChangedEvent for changed StateOptions.
protected Event	createEventByType(String eventType, String topic, String payload, @Nullable String source)	Create a new event instance based on the event type.
static ThingRemovedEvent	createRemovedEvent(Thing thing)	Creates a thing removed event.
static ThingStatusInfoChangedEvent	createStatusInfoChangedEvent(ThingUID thingUID, ThingStatusInfo thingStatusInfo, ThingStatusInfo oldThingStatusInfo)	Creates a new thing status info changed event based on a thing UID, a thing status info and the old thing status info object.
static ThingStatusInfoEvent	createStatusInfoEvent(ThingUID thingUID, ThingStatusInfo thingStatusInfo)	Creates a new thing status info event based on a thing UID and a thing status info object.
static ChannelTriggeredEvent	createTriggerEvent(String event, ChannelUID channelUID)	Creates a ChannelTriggeredEvent
static ThingUpdatedEvent	createUpdateEvent(Thing thing, Thing oldThing)	Creates a thing updated event.

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

checkNotNull, checkNotNullOrEmpty, createEvent, deserializePayload, getSupportedEventTypes, getTopicElements, serializePayload

Methods inherited from class java.lang.Object

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

Constructor Details

ThingEventFactory

public ThingEventFactory()

Constructs a new ThingEventFactory.

Method Details

createEventByType

protected Event createEventByType(String eventType,
 String topic,
 String payload,
 @Nullable String source)
                           throws Exception

Description copied from class: AbstractEventFactory

Create a new event instance based on the event type.

Specified by:

createEventByType in class AbstractEventFactory

Parameters:

eventType - the event type

topic - the topic

payload - the payload

source - the source, can be null

Returns:

the created event instance

Throws:

Exception - if the creation of the event fails

createChannelDescriptionChangedEvent

public static ChannelDescriptionChangedEvent createChannelDescriptionChangedEvent(ChannelUID channelUID,
 Set<String> linkedItemNames,
 StateDescriptionFragment stateDescription,
 @Nullable StateDescriptionFragment oldStateDescription)

Creates a ChannelDescriptionChangedEvent for a changed StateDescription. New and optional old value will be serialized to a JSON string from the StateDescriptionFragment object.

Parameters:

channelUID - the ChannelUID

linkedItemNames - a Set of linked item names

stateDescription - the new StateDescriptionFragment

oldStateDescription - the old StateDescriptionFragment

Returns:

Created ChannelDescriptionChangedEvent

createChannelDescriptionPatternChangedEvent

public static ChannelDescriptionChangedEvent createChannelDescriptionPatternChangedEvent(ChannelUID channelUID,
 Set<String> linkedItemNames,
 String pattern,
 @Nullable String oldPattern)

Creates a ChannelDescriptionChangedEvent for a changed pattern. New and optional old value will be serialized to a JSON string from the ThingEventFactory.ChannelDescriptionPatternPayloadBean object.

Parameters:

channelUID - the ChannelUID

linkedItemNames - a Set of linked item names

pattern - the new pattern

oldPattern - the old pattern

Returns:

Created ChannelDescriptionChangedEvent

createChannelDescriptionStateOptionsChangedEvent

public static ChannelDescriptionChangedEvent createChannelDescriptionStateOptionsChangedEvent(ChannelUID channelUID,
 Set<String> linkedItemNames,
 List<StateOption> options,
 @Nullable List<StateOption> oldOptions)

Creates a ChannelDescriptionChangedEvent for changed StateOptions. New and optional old value will be serialized to a JSON string from the ThingEventFactory.ChannelDescriptionStateOptionsPayloadBean object.

Parameters:

channelUID - the ChannelUID

linkedItemNames - a Set of linked item names

options - the new StateOptions

oldOptions - the old StateOptions

Returns:

Created ChannelDescriptionChangedEvent

createChannelDescriptionCommandOptionsChangedEvent

public static ChannelDescriptionChangedEvent createChannelDescriptionCommandOptionsChangedEvent(ChannelUID channelUID,
 Set<String> linkedItemNames,
 List<CommandOption> options,
 @Nullable List<CommandOption> oldOptions)

Creates a ChannelDescriptionChangedEvent for change CommandOptions. New and optional old value will be serialized to a JSON string from the ThingEventFactory.ChannelDescriptionCommandOptionsPayloadBean object.

Parameters:

channelUID - the ChannelUID

linkedItemNames - a Set of linked item names

options - the new CommandOptions

oldOptions - the old CommandOptions

Returns:

Created ChannelDescriptionChangedEvent

createTriggerEvent

public static ChannelTriggeredEvent createTriggerEvent(String event,
 ChannelUID channelUID)

Creates a ChannelTriggeredEvent

Parameters:

event - the event

channelUID - the ChannelUID

Returns:

Created ChannelTriggeredEvent

createStatusInfoEvent

public static ThingStatusInfoEvent createStatusInfoEvent(ThingUID thingUID,
 ThingStatusInfo thingStatusInfo)

Creates a new thing status info event based on a thing UID and a thing status info object.

Parameters:

thingUID - the thing UID

thingStatusInfo - the thing status info object

Returns:

the created thing status info event

Throws:

IllegalArgumentException - if thingUID or thingStatusInfo is null

createStatusInfoChangedEvent

public static ThingStatusInfoChangedEvent createStatusInfoChangedEvent(ThingUID thingUID,
 ThingStatusInfo thingStatusInfo,
 ThingStatusInfo oldThingStatusInfo)

Creates a new thing status info changed event based on a thing UID, a thing status info and the old thing status info object.

Parameters:

thingUID - the thing UID

thingStatusInfo - the thing status info object

oldThingStatusInfo - the old thing status info object

Returns:

the created thing status info changed event

Throws:

IllegalArgumentException - if thingUID or thingStatusInfo is null

createAddedEvent

public static ThingAddedEvent createAddedEvent(Thing thing)

Creates a thing added event.

Parameters:

thing - the thing

Returns:

the created thing added event

Throws:

IllegalArgumentException - if thing is null

createRemovedEvent

public static ThingRemovedEvent createRemovedEvent(Thing thing)

Creates a thing removed event.

Parameters:

thing - the thing

Returns:

the created thing removed event

Throws:

IllegalArgumentException - if thing is null

createUpdateEvent

public static ThingUpdatedEvent createUpdateEvent(Thing thing,
 Thing oldThing)

Creates a thing updated event.

Parameters:

thing - the thing

oldThing - the old thing

Returns:

the created thing updated event

Throws:

IllegalArgumentException - if thing or oldThing is null