Uses of Interface
org.openhab.core.types.State

Packages that use State

Package	Description
org.openhab.core.automation.module.script.defaultscope
org.openhab.core.automation.module.script.profile
org.openhab.core.items
org.openhab.core.items.events
org.openhab.core.library.items
org.openhab.core.library.types
org.openhab.core.magic.binding.handler
org.openhab.core.model.script.actions
org.openhab.core.model.script.scoping
org.openhab.core.persistence
org.openhab.core.persistence.dto
org.openhab.core.thing.binding
org.openhab.core.thing.binding.generic
org.openhab.core.thing.binding.generic.converter
org.openhab.core.thing.profiles
org.openhab.core.types
org.openhab.core.ui.items

Uses of State in org.openhab.core.automation.module.script.defaultscope

Methods in org.openhab.core.automation.module.script.defaultscope that return types with arguments of type State

Modifier and Type	Method	Description
Map<Item,State>	ScriptBusEvent.storeStates(Item @Nullable ... items)	Stores the current states for a list of items in a map.

Methods in org.openhab.core.automation.module.script.defaultscope with parameters of type State

Modifier and Type	Method	Description
@Nullable Object	ScriptBusEvent.postUpdate(@Nullable Item item, @Nullable State state)	Posts a status update for a specified item to the event bus.

Method parameters in org.openhab.core.automation.module.script.defaultscope with type arguments of type State

Modifier and Type	Method	Description
@Nullable Object	ScriptBusEvent.restoreStates(@Nullable Map<Item,State> statesMap)	Restores item states from a map.
@Nullable Object	ScriptBusEvent.sendTimeSeries(@Nullable String itemName, @Nullable Map<ZonedDateTime,State> values, String policy)	Sends a time series to the event bus

Uses of State in org.openhab.core.automation.module.script.profile

Methods in org.openhab.core.automation.module.script.profile with parameters of type State

Modifier and Type	Method	Description
void	ScriptProfile.onStateUpdateFromHandler(State state)
void	ScriptProfile.onStateUpdateFromItem(State state)

Uses of State in org.openhab.core.items

Fields in org.openhab.core.items declared as State

Modifier and Type	Field	Description
protected State	GenericItem.state

Methods in org.openhab.core.items with type parameters of type State

Modifier and Type	Method	Description
<T extends State> @Nullable T	GenericItem.getStateAs(Class<T> typeClass)
<T extends State> @Nullable T	GroupFunction.Equality.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	GroupFunction.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)	Calculates the group state and returns it as a state of the requested type.
<T extends State> @Nullable T	GroupItem.getStateAs(Class<T> typeClass)
<T extends State> @Nullable T	Item.getStateAs(Class<T> typeClass)	returns the current state of the item as a specific type

Methods in org.openhab.core.items that return State

Modifier and Type	Method	Description
State	GroupFunction.calculate(@Nullable Set<Item> items)	Determines the current state of a group based on a list of items
State	GroupFunction.Equality.calculate(@Nullable Set<Item> items)
State	ItemStateConverter.convertToAcceptedState(@Nullable State state, @Nullable Item item)	Convert the given State to a state which is acceptable for the given Item.
State[]	GroupFunction.Equality.getParameters()
State[]	GroupFunction.getParameters()	Returns the parameters of the function as an array.
State	GenericItem.getState()
State	Item.getState()	returns the current state of the item

Methods in org.openhab.core.items that return types with arguments of type State

Modifier and Type	Method	Description
List<Class<? extends State>>	GroupItem.getAcceptedDataTypes()	The accepted data types of a group item is the same as of the underlying base item.
List<Class<? extends State>>	Item.getAcceptedDataTypes()	This method provides a list of all data types that can be used to update the item state

Methods in org.openhab.core.items with parameters of type State

Modifier and Type	Method	Description
protected final void	GenericItem.applyState(State state)	Sets new state, notifies listeners and sends events.
State	ItemStateConverter.convertToAcceptedState(@Nullable State state, @Nullable Item item)	Convert the given State to a state which is acceptable for the given Item.
boolean	GenericItem.isAcceptedState(List<Class<? extends State>> acceptedDataTypes, State state)	Tests if state is within acceptedDataTypes list or a subclass of one of them
protected void	GenericItem.logSetTypeError(State state)
protected void	GenericItem.notifyListeners(State oldState, State newState)
void	GenericItem.setState(State state)	Set a new state.
void	GroupItem.setState(State state)
void	GroupItem.stateChanged(Item item, State oldState, State newState)
void	StateChangeListener.stateChanged(Item item, State oldState, State newState)	This method is called, if a state has changed.
void	GroupItem.stateUpdated(Item item, State state)
void	StateChangeListener.stateUpdated(Item item, State state)	This method is called, if a state was updated, but has not changed

Method parameters in org.openhab.core.items with type arguments of type State

Modifier and Type	Method	Description
boolean	GenericItem.isAcceptedState(List<Class<? extends State>> acceptedDataTypes, State state)	Tests if state is within acceptedDataTypes list or a subclass of one of them

Uses of State in org.openhab.core.items.events

Fields in org.openhab.core.items.events declared as State

Modifier and Type	Field	Description
protected final State	ItemStateChangedEvent.itemState
protected final State	ItemStateEvent.itemState
protected final State	ItemStateUpdatedEvent.itemState
protected final State	ItemStateChangedEvent.oldItemState
protected final State	ItemStatePredictedEvent.predictedState

Methods in org.openhab.core.items.events that return State

Modifier and Type	Method	Description
State	ItemStateChangedEvent.getItemState()	Gets the item state.
State	ItemStateEvent.getItemState()	Gets the item state.
State	ItemStateUpdatedEvent.getItemState()	Gets the item state.
State	ItemStateChangedEvent.getOldItemState()	Gets the old item state.
State	ItemStatePredictedEvent.getPredictedState()	Gets the predicted item state.

Methods in org.openhab.core.items.events with parameters of type State

Modifier and Type	Method	Description
static GroupItemStateChangedEvent	ItemEventFactory.createGroupStateChangedEvent(String itemName, String memberName, State newState, State oldState)	Creates a group item state changed event.
static GroupStateUpdatedEvent	ItemEventFactory.createGroupStateUpdatedEvent(String groupName, String member, State state, @Nullable String source)	Creates a group item state updated event.
static ItemStateChangedEvent	ItemEventFactory.createStateChangedEvent(String itemName, State newState, State oldState)	Creates an item state changed event.
static ItemEvent	ItemEventFactory.createStateEvent(String itemName, State state)	Creates an item state event.
static ItemStateEvent	ItemEventFactory.createStateEvent(String itemName, State state, @Nullable String source)	Creates an item state event.
static ItemStatePredictedEvent	ItemEventFactory.createStatePredictedEvent(String itemName, State state, boolean isConfirmation)	Creates an item state predicted event.
static ItemStateUpdatedEvent	ItemEventFactory.createStateUpdatedEvent(String itemName, State state)	Creates an item state updated event.
static ItemStateUpdatedEvent	ItemEventFactory.createStateUpdatedEvent(String itemName, State state, @Nullable String source)	Creates an item state updated event.

Constructors in org.openhab.core.items.events with parameters of type State

Modifier	Constructor	Description
protected	GroupItemStateChangedEvent(String topic, String payload, String itemName, String memberName, State newItemState, State oldItemState)
protected	GroupStateUpdatedEvent(String topic, String payload, String itemName, String memberName, State newItemState, @Nullable String source)
protected	ItemStateChangedEvent(String topic, String payload, String itemName, State newItemState, State oldItemState)	Constructs a new item state changed event.
protected	ItemStateEvent(String topic, String payload, String itemName, State itemState, @Nullable String source)	Constructs a new item state event.
	ItemStatePredictedEvent(String topic, String payload, String itemName, State predictedState, boolean isConfirmation)	Constructs a new item state predicted event.
protected	ItemStateUpdatedEvent(String topic, String payload, String itemName, State itemState, @Nullable String source)	Constructs a new item state event.

Uses of State in org.openhab.core.library.items

Methods in org.openhab.core.library.items with type parameters of type State

Modifier and Type	Method	Description
<T extends State> @Nullable T	StringItem.getStateAs(Class<T> typeClass)

Methods in org.openhab.core.library.items that return types with arguments of type State

Modifier and Type	Method	Description
List<Class<? extends State>>	CallItem.getAcceptedDataTypes()
List<Class<? extends State>>	ColorItem.getAcceptedDataTypes()
List<Class<? extends State>>	ContactItem.getAcceptedDataTypes()
List<Class<? extends State>>	DateTimeItem.getAcceptedDataTypes()
List<Class<? extends State>>	DimmerItem.getAcceptedDataTypes()
List<Class<? extends State>>	ImageItem.getAcceptedDataTypes()
List<Class<? extends State>>	LocationItem.getAcceptedDataTypes()
List<Class<? extends State>>	NumberItem.getAcceptedDataTypes()
List<Class<? extends State>>	PlayerItem.getAcceptedDataTypes()
List<Class<? extends State>>	RollershutterItem.getAcceptedDataTypes()
List<Class<? extends State>>	StringItem.getAcceptedDataTypes()
List<Class<? extends State>>	SwitchItem.getAcceptedDataTypes()

Methods in org.openhab.core.library.items with parameters of type State

Modifier and Type	Method	Description
void	CallItem.setState(State state)
void	ColorItem.setState(State state)
void	ContactItem.setState(State state)
void	DateTimeItem.setState(State state)
void	DimmerItem.setState(State state)
void	ImageItem.setState(State state)
void	LocationItem.setState(State state)
void	NumberItem.setState(State state)
void	PlayerItem.setState(State state)
void	RollershutterItem.setState(State state)
void	StringItem.setState(State state)
void	SwitchItem.setState(State state)

Uses of State in org.openhab.core.library.types

Classes in org.openhab.core.library.types that implement State

Modifier and Type	Class	Description
class	DateTimeType
class	DecimalType	The decimal type uses a BigDecimal internally and thus can be used for integers, longs and floating point numbers alike.
class	HSBType	The HSBType is a complex type with constituents for hue, saturation and brightness and can be used for color items.
enum	OnOffType
enum	OpenClosedType
class	PercentType	The PercentType extends the DecimalType by putting constraints for its value on top (0-100).
enum	PlayPauseType	This type is used by the PlayerItem.
class	PointType	This type can be used for items that are dealing with GPS or location awareness functionality.
class	QuantityType<T extends javax.measure.Quantity<T>>	The measure type extends DecimalType to handle physical unit measurement
class	RawType	This type can be used for all binary data such as images, documents, sounds etc.
enum	RewindFastforwardType	This type is used by the PlayerItem.
class	StringListType	This type can be used for items that are dealing with telephony functionality.
class	StringType
enum	UpDownType

Fields in org.openhab.core.library.types declared as State

Modifier and Type	Field	Description
protected final State	ArithmeticGroupFunction.And.activeState
protected final State	ArithmeticGroupFunction.Or.activeState
protected final State	ArithmeticGroupFunction.And.passiveState
protected final State	ArithmeticGroupFunction.Or.passiveState

Methods in org.openhab.core.library.types with type parameters of type State

Modifier and Type	Method	Description
<T extends State> @Nullable T	DecimalType.as(@Nullable Class<T> target)
<T extends State> @Nullable T	HSBType.as(@Nullable Class<T> target)
<T extends State> @Nullable T	OnOffType.as(@Nullable Class<T> target)
<T extends State> @Nullable T	OpenClosedType.as(@Nullable Class<T> target)
<T extends State> @Nullable T	PercentType.as(@Nullable Class<T> target)
<U extends State> @Nullable U	QuantityType.as(@Nullable Class<U> target)
<T extends State> @Nullable T	UpDownType.as(@Nullable Class<T> target)
protected <T extends State> @Nullable T	DecimalType.defaultConversion(@Nullable Class<T> target)
<T extends State> @Nullable T	ArithmeticGroupFunction.And.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	ArithmeticGroupFunction.Avg.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	ArithmeticGroupFunction.Count.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	ArithmeticGroupFunction.Max.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	ArithmeticGroupFunction.Min.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	ArithmeticGroupFunction.Or.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	ArithmeticGroupFunction.Sum.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	DateTimeGroupFunction.Earliest.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	DateTimeGroupFunction.Latest.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)
<T extends State> @Nullable T	QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction.getStateAs(@Nullable Set<Item> items, Class<T> stateClass)

Methods in org.openhab.core.library.types that return State

Modifier and Type	Method	Description
State	ArithmeticGroupFunction.And.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.Avg.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.Count.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.Max.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.Min.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.NAnd.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.NOr.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.Or.calculate(@Nullable Set<Item> items)
State	ArithmeticGroupFunction.Sum.calculate(@Nullable Set<Item> items)
State	DateTimeGroupFunction.Earliest.calculate(@Nullable Set<Item> items)
State	DateTimeGroupFunction.Latest.calculate(@Nullable Set<Item> items)
State	QuantityTypeArithmeticGroupFunction.Avg.calculate(@Nullable Set<Item> items)
State	QuantityTypeArithmeticGroupFunction.Max.calculate(@Nullable Set<Item> items)
State	QuantityTypeArithmeticGroupFunction.Min.calculate(@Nullable Set<Item> items)
State	QuantityTypeArithmeticGroupFunction.Sum.calculate(@Nullable Set<Item> items)
State[]	ArithmeticGroupFunction.And.getParameters()
State[]	ArithmeticGroupFunction.Avg.getParameters()
State[]	ArithmeticGroupFunction.Count.getParameters()
State[]	ArithmeticGroupFunction.Max.getParameters()
State[]	ArithmeticGroupFunction.Min.getParameters()
State[]	ArithmeticGroupFunction.Or.getParameters()
State[]	ArithmeticGroupFunction.Sum.getParameters()
State[]	DateTimeGroupFunction.Earliest.getParameters()
State[]	DateTimeGroupFunction.Latest.getParameters()
State[]	QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction.getParameters()

Constructors in org.openhab.core.library.types with parameters of type State

Modifier	Constructor	Description
	And(@Nullable State activeValue, @Nullable State passiveValue)
	Count(@Nullable State regExpr)
	NAnd(@Nullable State activeValue, @Nullable State passiveValue)
	NOr(@Nullable State activeValue, @Nullable State passiveValue)
	Or(@Nullable State activeValue, @Nullable State passiveValue)

Uses of State in org.openhab.core.magic.binding.handler

Methods in org.openhab.core.magic.binding.handler with parameters of type State

Modifier and Type	Method	Description
protected void	MagicChattyThingHandler.updateState(ChannelUID channelUID, State state)

Uses of State in org.openhab.core.model.script.actions

Methods in org.openhab.core.model.script.actions that return types with arguments of type State

Modifier and Type	Method	Description
static Map<Item,State>	BusEvent.storeStates(Item... items)	Stores the current states for a list of items in a map.

Methods in org.openhab.core.model.script.actions with parameters of type State

Modifier and Type	Method	Description
static Object	BusEvent.postUpdate(Item item, State state)	Posts a status update for a specified item to the event bus.

Method parameters in org.openhab.core.model.script.actions with type arguments of type State

Modifier and Type	Method	Description
static Object	BusEvent.restoreStates(Map<Item,State> statesMap)	Restores item states from a map.
static Object	BusEvent.sendTimeSeries(@Nullable String itemName, @Nullable Map<ZonedDateTime,State> values, String policy)	Sends a time series to the event bus

Uses of State in org.openhab.core.model.script.scoping

Fields in org.openhab.core.model.script.scoping with type parameters of type State

Modifier and Type	Field	Description
protected static final Set<State>	StateAndCommandProvider.STATES

Methods in org.openhab.core.model.script.scoping that return types with arguments of type State

Modifier and Type	Method	Description
Iterable<State>	StateAndCommandProvider.getAllStates()

Uses of State in org.openhab.core.persistence

Methods in org.openhab.core.persistence that return State

Modifier and Type	Method	Description
@Nullable State	FilterCriteria.getState()
State	HistoricItem.getState()	returns the current state of the item

Methods in org.openhab.core.persistence with parameters of type State

Modifier and Type	Method	Description
FilterCriteria	FilterCriteria.setState(State state)
void	ModifiablePersistenceService.store(Item item, ZonedDateTime date, State state)	Stores the historic item value.
void	ModifiablePersistenceService.store(Item item, ZonedDateTime date, State state, @Nullable String alias)	Stores the historic item value under a specified alias.

Uses of State in org.openhab.core.persistence.dto

Methods in org.openhab.core.persistence.dto with parameters of type State

Modifier and Type	Method	Description
void	ItemHistoryDTO.addData(long time, State state)	Add a new record to the data history.

Uses of State in org.openhab.core.thing.binding

Methods in org.openhab.core.thing.binding with parameters of type State

Modifier and Type	Method	Description
void	ThingHandlerCallback.stateUpdated(ChannelUID channelUID, State state)	Informs about an updated state for a channel.
protected void	BaseThingHandler.updateState(String channelID, State state)	Updates the state of the thing.
protected void	BaseThingHandler.updateState(ChannelUID channelUID, State state)	Updates the state of the thing.

Uses of State in org.openhab.core.thing.binding.generic

Methods in org.openhab.core.thing.binding.generic that return State

Modifier and Type	Method	Description
@Nullable State	ChannelValueConverterConfig.fixedValueToState(String string)	maps a user-defined string to a state

Method parameters in org.openhab.core.thing.binding.generic with type arguments of type State

Modifier and Type	Method	Description
ChannelHandler	ChannelHandler.Factory.create(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendHttpValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)

Uses of State in org.openhab.core.thing.binding.generic.converter

Methods in org.openhab.core.thing.binding.generic.converter that return types with arguments of type State

Modifier and Type	Method	Description
Optional<State>	ColorChannelHandler.toState(String string)
Optional<State>	DimmerChannelHandler.toState(String string)
Optional<State>	FixedValueMappingChannelHandler.toState(String string)
protected Optional<State>	GenericChannelHandler.toState(String value)
protected Optional<State>	NumberChannelHandler.toState(String value)
Optional<State>	PlayerChannelHandler.toState(String string)
Optional<State>	RollershutterChannelHandler.toState(String string)

Constructor parameters in org.openhab.core.thing.binding.generic.converter with type arguments of type State

Modifier	Constructor	Description
	ColorChannelHandler(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	DimmerChannelHandler(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	FixedValueMappingChannelHandler(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	GenericChannelHandler(Function<String,State> toState, Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	GenericChannelHandler(Function<String,State> toState, Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	ImageChannelHandler(Consumer<State> updateState)
	NumberChannelHandler(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	PlayerChannelHandler(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)
	RollershutterChannelHandler(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)

Uses of State in org.openhab.core.thing.profiles

Methods in org.openhab.core.thing.profiles that return types with arguments of type State

Modifier and Type	Method	Description
default List<Class<? extends State>>	ProfileContext.getAcceptedDataTypes()	Get the list of accepted data types for state updates to the linked item This is an optional method and will return an empty list if not implemented.

Methods in org.openhab.core.thing.profiles with parameters of type State

Modifier and Type	Method	Description
void	StateProfile.onStateUpdateFromHandler(State state)	If the binding indicated a state update on a channel, then this method will be called for each linked item.
void	Profile.onStateUpdateFromItem(State state)	Will be called if an item has changed its state and this information should be forwarded to the binding.
void	ProfileCallback.sendUpdate(State state)	Send a state update to the framework.

Uses of State in org.openhab.core.types

Classes in org.openhab.core.types that implement State

Modifier and Type	Class	Description
enum	UnDefType	There are situations when item states do not have any defined value.

Methods in org.openhab.core.types with type parameters of type State

Modifier and Type	Method	Description
default <T extends @Nullable State> @Nullable T	State.as(@Nullable Class<T> target)	Convert this State's value into another type

Methods in org.openhab.core.types that return State

Modifier and Type	Method	Description
static @Nullable State	TypeParser.parseState(List<Class<? extends State>> types, String s)	Determines a state from a string.
State	TimeSeries.Entry.state()	Returns the value of the state record component.

Methods in org.openhab.core.types with parameters of type State

Modifier and Type	Method	Description
void	TimeSeries.add(Instant timestamp, State state)	Add a new element to this series.

Method parameters in org.openhab.core.types with type arguments of type State

Modifier and Type	Method	Description
static @Nullable State	TypeParser.parseState(List<Class<? extends State>> types, String s)	Determines a state from a string.

Constructors in org.openhab.core.types with parameters of type State

Modifier	Constructor	Description
	Entry(Instant timestamp, State state)	Creates an instance of a Entry record class.

Uses of State in org.openhab.core.ui.items

Methods in org.openhab.core.ui.items that return State

Modifier and Type	Method	Description
@Nullable State	ItemUIRegistry.convertState(Widget widget, Item item, State state)	Convert the given state into
@Nullable State	ItemUIRegistry.convertStateToLabelUnit(QuantityType<?> state, String label)	Convert the given state to the unit found in label.
@Nullable State	ItemUIRegistry.getItemState(String itemName)	Gets the item state
@Nullable State	ItemUIRegistry.getState(Widget w)	Retrieves the current state of the item of a widget or UnDefType.UNDEF.

Methods in org.openhab.core.ui.items with parameters of type State

Modifier and Type	Method	Description
@Nullable State	ItemUIRegistry.convertState(Widget widget, Item item, State state)	Convert the given state into