Package org.openhab.core.items.events

Class ItemTimeSeriesEvent

java.lang.Object

org.openhab.core.events.AbstractEvent

org.openhab.core.items.events.ItemEvent

org.openhab.core.items.events.ItemTimeSeriesEvent

All Implemented Interfaces:

Event

@NonNullByDefault
public class ItemTimeSeriesEvent
extends ItemEvent

The ItemTimeSeriesEvent can be used to report item time series updates through the openHAB event bus. Time series events must be created with the ItemEventFactory.

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
protected final TimeSeries	timeSeries
static final String	TYPE

Fields inherited from class org.openhab.core.items.events.ItemEvent

itemName

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

ACTOR_SEPARATOR, DELEGATION_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ItemTimeSeriesEvent(String topic, String payload, String itemName, TimeSeries timeSeries, @Nullable String source)	Constructs a new item time series event.

Method Summary

Modifier and Type	Method	Description
TimeSeries	getTimeSeries()	Gets the item time series.
String	getType()	Gets the event type.
String	toString()

Methods inherited from class org.openhab.core.items.events.ItemEvent

getItemName

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

timeSeries

protected final TimeSeries timeSeries

Constructor Details

ItemTimeSeriesEvent

protected ItemTimeSeriesEvent(String topic,
 String payload,
 String itemName,
 TimeSeries timeSeries,
 @Nullable String source)

Constructs a new item time series event.

Parameters:

topic - the topic

payload - the payload

itemName - the item name

timeSeries - the time series

source - the source, can be null

Method Details

getType

public String getType()

Description copied from interface: Event

Gets the event type.

Returns:

the event type

getTimeSeries

public TimeSeries getTimeSeries()

Gets the item time series.

Returns:

the item time series

toString

public String toString()

Overrides:

toString in class Object