Package org.openhab.core.library.items

Class ContactItem

java.lang.Object

org.openhab.core.items.GenericItem

org.openhab.core.library.items.ContactItem

All Implemented Interfaces:

Identifiable<String>, ActiveItem, Item

@NonNullByDefault
public class ContactItem
extends GenericItem

A ContactItem can be used for sensors that return an "open" or "close" as a state. This is useful for doors, windows, etc.

Author:

Kai Kreuzer - Initial contribution

Field Summary

Fields inherited from class org.openhab.core.items.GenericItem

category, eventPublisher, groupNames, itemStateConverter, label, lastState, lastStateChange, lastStateUpdate, listeners, name, state, tags, timeSeriesListeners, type

Constructor Summary

Constructors

Constructor	Description
ContactItem(String name)

Method Summary

Modifier and Type	Method	Description
List<Class<? extends Command>>	getAcceptedCommandTypes()	This method provides a list of all command types that can be used for this item
List<Class<? extends State>>	getAcceptedDataTypes()	This method provides a list of all data types that can be used to update the item state
@Nullable CommandDescription	getCommandDescription(@Nullable Locale locale)	Returns the CommandDescription for the given locale.
void	setState(State state, @Nullable String source)	Set a new state.
void	setTimeSeries(TimeSeries timeSeries)	Set a new time series.

Methods inherited from class org.openhab.core.items.GenericItem

addGroupName, addGroupNames, addGroupNames, addStateChangeListener, addTag, addTags, addTags, addTimeSeriesListener, applyState, applyTimeSeries, dispose, equals, getCategory, getCommandOptions, getGroupNames, getLabel, getLastState, getLastStateChange, getLastStateUpdate, getName, getState, getStateAs, getStateDescription, getStateDescription, getTags, getType, getUID, hashCode, hasTag, internalSend, isAcceptedState, logSetTypeError, logSetTypeError, notifyListeners, removeAllTags, removeGroupName, removeStateChangeListener, removeTag, removeTimeSeriesListener, send, send, setCategory, setCommandDescriptionService, setEventPublisher, setItemStateConverter, setLabel, setState, setState, setStateDescriptionService, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.items.Item

getCommandDescription

Constructor Details

ContactItem

public ContactItem(String name)

Method Details

getAcceptedDataTypes

public List<Class<? extends State>> getAcceptedDataTypes()

Description copied from interface: Item

This method provides a list of all data types that can be used to update the item state

Imagine e.g. a dimmer device: It's status could be 0%, 10%, 50%, 100%, but also OFF or ON and maybe UNDEFINED. So the accepted data types would be in this case PercentType, and UnDefType

The order of data types denotes the order of preference. So in case a state needs to be converted in order to be accepted, it will be attempted to convert it to a type from top to bottom. Therefore the type with the least information loss should be on top of the list - in the example above the PercentType carries more information than the , hence it is listed first.

Returns:

a list of data types that can be used to update the item state

getAcceptedCommandTypes

public List<Class<? extends Command>> getAcceptedCommandTypes()

Description copied from interface: Item

This method provides a list of all command types that can be used for this item

Imagine e.g. a dimmer device: You could ask it to dim to 0%, 10%, 50%, 100%, but also to turn OFF or ON. So the accepted command types would be in this case PercentType,

Returns:

a list of all command types that can be used for this item

setState

public void setState(State state,
 @Nullable String source)

Description copied from class: GenericItem

Set a new state. Subclasses may override this method in order to do necessary conversions upfront. Afterwards, GenericItem.applyState(State, String) should be called by classes overriding this method.

Overrides:

setState in class GenericItem

Parameters:

state - new state of this item

source - the source of the state update. See https://www.openhab.org/docs/developer/utils/events.html#the-core-events

setTimeSeries

public void setTimeSeries(TimeSeries timeSeries)

Description copied from class: GenericItem

Set a new time series.

Subclasses may override this method in order to do necessary conversions upfront. Afterwards, GenericItem.applyTimeSeries(TimeSeries) should be called by classes overriding this method.

A time series may only contain events that are compatible with the item's internal state.

Overrides:

setTimeSeries in class GenericItem

Parameters:

timeSeries - new time series of this item

getCommandDescription

public @Nullable CommandDescription getCommandDescription(@Nullable Locale locale)

Description copied from interface: Item

Returns the CommandDescription for the given locale. In case no dedicated CommandDescription is provided the StateOptions from the StateDescription will be served as valid CommandOptions.

Specified by:

getCommandDescription in interface Item

Overrides:

getCommandDescription in class GenericItem

Parameters:

locale - locale (can be null)

Returns:

command description (can be null)