Uses of Interface
org.openhab.core.types.State
Packages that use State
Package
Description
-
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 StateModifier and TypeMethodDescriptionScriptBusEvent.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 StateModifier and TypeMethodDescription@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 StateModifier and TypeMethodDescription@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 StateModifier and TypeMethodDescriptionvoid
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 StateModifier and TypeFieldDescriptionprotected @Nullable State
GenericItem.lastState
protected State
GenericItem.state
Methods in org.openhab.core.items with type parameters of type StateModifier and TypeMethodDescription<T extends State>
@Nullable TGenericItem.getStateAs
(Class<T> typeClass) <T extends State>
@Nullable TGroupFunction.Equality.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TGroupFunction.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 TGroupItem.getStateAs
(Class<T> typeClass) <T extends State>
@Nullable TItem.getStateAs
(Class<T> typeClass) returns the current state of the item as a specific typeMethods in org.openhab.core.items that return StateModifier and TypeMethodDescriptionDetermines the current state of a group based on a list of itemsItemStateConverter.convertToAcceptedState
(@Nullable State state, @Nullable Item item) @Nullable State
GenericItem.getLastState()
@Nullable State
Item.getLastState()
Returns the previous state of the item.State[]
GroupFunction.Equality.getParameters()
State[]
GroupFunction.getParameters()
Returns the parameters of the function as an array.GenericItem.getState()
Item.getState()
returns the current state of the itemMethods in org.openhab.core.items that return types with arguments of type StateModifier and TypeMethodDescriptionGroupItem.getAcceptedDataTypes()
The accepted data types of a group item is the same as of the underlying base item.Item.getAcceptedDataTypes()
This method provides a list of all data types that can be used to update the item stateMethods in org.openhab.core.items with parameters of type StateModifier and TypeMethodDescriptionprotected final void
GenericItem.applyState
(State state) Sets new state, notifies listeners and sends events.ItemStateConverter.convertToAcceptedState
(@Nullable State state, @Nullable Item item) boolean
GenericItem.isAcceptedState
(List<Class<? extends State>> acceptedDataTypes, State state) Tests if state is within acceptedDataTypes list or a subclass of one of themprotected void
GenericItem.logSetTypeError
(State state) protected void
GenericItem.notifyListeners
(State oldState, State newState) void
Set a new state.void
GenericItem.setState
(State state, @Nullable State lastState, @Nullable ZonedDateTime lastStateUpdate, @Nullable ZonedDateTime lastStateChange) Set a new state, lastState, lastStateUpdate and lastStateChange.void
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 changedMethod parameters in org.openhab.core.items with type arguments of type StateModifier and TypeMethodDescriptionboolean
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 StateModifier and TypeFieldDescriptionprotected 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 StateModifier and TypeMethodDescriptionItemStateChangedEvent.getItemState()
Gets the item state.ItemStateEvent.getItemState()
Gets the item state.ItemStateUpdatedEvent.getItemState()
Gets the item state.ItemStateChangedEvent.getOldItemState()
Gets the old item state.ItemStatePredictedEvent.getPredictedState()
Gets the predicted item state.Methods in org.openhab.core.items.events with parameters of type StateModifier and TypeMethodDescriptionstatic GroupItemStateChangedEvent
ItemEventFactory.createGroupStateChangedEvent
(String itemName, String memberName, State newState, State oldState, @Nullable ZonedDateTime lastStateUpdate, @Nullable ZonedDateTime lastStateChange) Creates a group item state changed event.static GroupStateUpdatedEvent
ItemEventFactory.createGroupStateUpdatedEvent
(String groupName, String member, State state, @Nullable ZonedDateTime lastStateUpdate, @Nullable String source) Creates a group item state updated event.static ItemStateChangedEvent
ItemEventFactory.createStateChangedEvent
(String itemName, State newState, State oldState, @Nullable ZonedDateTime lastStateUpdate, @Nullable ZonedDateTime lastStateChange) 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, @Nullable ZonedDateTime lastStateUpdate) Creates an item state updated event.static ItemStateUpdatedEvent
ItemEventFactory.createStateUpdatedEvent
(String itemName, State state, @Nullable ZonedDateTime lastStateUpdate, @Nullable String source) Creates an item state updated event.Constructors in org.openhab.core.items.events with parameters of type StateModifierConstructorDescriptionprotected
GroupItemStateChangedEvent
(String topic, String payload, String itemName, String memberName, State newItemState, State oldItemState, @Nullable ZonedDateTime lastStateUpdate, @Nullable ZonedDateTime lastStateChange) protected
GroupStateUpdatedEvent
(String topic, String payload, String itemName, String memberName, State newItemState, @Nullable ZonedDateTime lastStateUpdate, @Nullable String source) protected
ItemStateChangedEvent
(String topic, String payload, String itemName, State newItemState, State oldItemState, @Nullable ZonedDateTime lastStateUpdate, @Nullable ZonedDateTime lastStateChange) 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 ZonedDateTime lastStateUpdate, @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 StateModifier and TypeMethodDescription<T extends State>
@Nullable TStringItem.getStateAs
(Class<T> typeClass) Methods in org.openhab.core.library.items that return types with arguments of type StateModifier and TypeMethodDescriptionCallItem.getAcceptedDataTypes()
ColorItem.getAcceptedDataTypes()
ContactItem.getAcceptedDataTypes()
DateTimeItem.getAcceptedDataTypes()
DimmerItem.getAcceptedDataTypes()
ImageItem.getAcceptedDataTypes()
LocationItem.getAcceptedDataTypes()
NumberItem.getAcceptedDataTypes()
PlayerItem.getAcceptedDataTypes()
RollershutterItem.getAcceptedDataTypes()
StringItem.getAcceptedDataTypes()
SwitchItem.getAcceptedDataTypes()
Methods in org.openhab.core.library.items with parameters of type StateModifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
-
Uses of State in org.openhab.core.library.types
Classes in org.openhab.core.library.types that implement StateModifier and TypeClassDescriptionclass
class
The decimal type uses a BigDecimal internally and thus can be used for integers, longs and floating point numbers alike.class
The HSBType is a complex type with constituents for hue, saturation and brightness and can be used for color items.enum
enum
class
The PercentType extends theDecimalType
by putting constraints for its value on top (0-100).enum
This type is used by thePlayerItem
.class
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 measurementclass
This type can be used for all binary data such as images, documents, sounds etc.enum
This type is used by thePlayerItem
.class
This type can be used for items that are dealing with telephony functionality.class
enum
Fields in org.openhab.core.library.types declared as StateModifier and TypeFieldDescriptionprotected final State
ArithmeticGroupFunction.And.activeState
protected final State
ArithmeticGroupFunction.Or.activeState
protected final State
ArithmeticGroupFunction.Xor.activeState
protected final State
ArithmeticGroupFunction.And.passiveState
protected final State
ArithmeticGroupFunction.Or.passiveState
protected final State
ArithmeticGroupFunction.Xor.passiveState
Methods in org.openhab.core.library.types with type parameters of type StateModifier and TypeMethodDescription<T extends State>
@Nullable T<T extends State>
@Nullable T<T extends State>
@Nullable T<T extends State>
@Nullable T<T extends State>
@Nullable T<U extends State>
@Nullable U<T extends State>
@Nullable Tprotected <T extends State>
@Nullable TDecimalType.defaultConversion
(@Nullable Class<T> target) <T extends State>
@Nullable TArithmeticGroupFunction.And.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Avg.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Count.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Max.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Median.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Min.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Or.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Sum.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TArithmeticGroupFunction.Xor.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TDateTimeGroupFunction.Earliest.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TDateTimeGroupFunction.Latest.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) <T extends State>
@Nullable TQuantityTypeArithmeticGroupFunction.DimensionalGroupFunction.getStateAs
(@Nullable Set<Item> items, Class<T> stateClass) Methods in org.openhab.core.library.types that return StateModifier and TypeMethodDescriptionState[]
ArithmeticGroupFunction.And.getParameters()
State[]
ArithmeticGroupFunction.Avg.getParameters()
State[]
ArithmeticGroupFunction.Count.getParameters()
State[]
ArithmeticGroupFunction.Max.getParameters()
State[]
ArithmeticGroupFunction.Median.getParameters()
State[]
ArithmeticGroupFunction.Min.getParameters()
State[]
ArithmeticGroupFunction.Or.getParameters()
State[]
ArithmeticGroupFunction.Sum.getParameters()
State[]
ArithmeticGroupFunction.Xor.getParameters()
State[]
DateTimeGroupFunction.Earliest.getParameters()
State[]
DateTimeGroupFunction.Latest.getParameters()
State[]
QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction.getParameters()
Constructors in org.openhab.core.library.types with parameters of type StateModifierConstructorDescription -
Uses of State in org.openhab.core.magic.binding.handler
Methods in org.openhab.core.magic.binding.handler with parameters of type StateModifier and TypeMethodDescriptionprotected 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 StateModifier and TypeMethodDescriptionBusEvent.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 StateModifier and TypeMethodDescriptionstatic 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 StateModifier and TypeMethodDescriptionstatic 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 StateMethods in org.openhab.core.model.script.scoping that return types with arguments of type State -
Uses of State in org.openhab.core.persistence
Methods in org.openhab.core.persistence that return StateModifier and TypeMethodDescription@Nullable State
PersistedItem.getLastState()
returns the last state of the item@Nullable State
FilterCriteria.getState()
HistoricItem.getState()
returns the current state of the itemMethods in org.openhab.core.persistence with parameters of type StateModifier and TypeMethodDescriptionvoid
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 -
Uses of State in org.openhab.core.persistence.extensions
Methods in org.openhab.core.persistence.extensions that return StateModifier and TypeMethodDescriptionstatic @Nullable State
PersistenceExtensions.averageBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the average value of the state of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.averageBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the average value of the state of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.averageBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type) Gets the average value of the state of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.averageBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the average value of the state of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.averageSince
(Item item, ZonedDateTime timestamp) Gets the average value of the state of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.averageSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the average value of the state of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.averageSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the average value of the state of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.averageSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the average value of the state of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.averageUntil
(Item item, ZonedDateTime timestamp) Gets the average value of the state of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.averageUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the average value of the state of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.averageUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the average value of the state of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.averageUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the average value of the state of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.deltaBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the difference value of the state of a givenitem
between two points in time.static @Nullable State
PersistenceExtensions.deltaBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the difference value of the state of a givenitem
between two points in time.static @Nullable State
PersistenceExtensions.deltaSince
(Item item, ZonedDateTime timestamp) Gets the difference value of the state of a givenitem
since a certain point in time.static @Nullable State
PersistenceExtensions.deltaSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the difference value of the state of a givenitem
since a certain point in time.static @Nullable State
PersistenceExtensions.deltaUntil
(Item item, ZonedDateTime timestamp) Gets the difference value of the state of a givenitem
until a certain point in time.static @Nullable State
PersistenceExtensions.deltaUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the difference value of the state of a givenitem
until a certain point in time.static @Nullable State
PersistenceExtensions.deviationBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the standard deviation of the state of the givenItem
between two points in time.static @Nullable State
PersistenceExtensions.deviationBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the standard deviation of the state of the givenItem
between two points in time.static @Nullable State
PersistenceExtensions.deviationBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type) Gets the standard deviation of the state of the givenItem
between two points in time.static @Nullable State
PersistenceExtensions.deviationBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the standard deviation of the state of the givenItem
between two points in time.static @Nullable State
PersistenceExtensions.deviationSince
(Item item, ZonedDateTime timestamp) Gets the standard deviation of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.deviationSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the standard deviation of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.deviationSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the standard deviation of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.deviationSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the standard deviation of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.deviationUntil
(Item item, ZonedDateTime timestamp) Gets the standard deviation of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.deviationUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the standard deviation of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.deviationUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the standard deviation of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.deviationUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the standard deviation of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.medianBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the median value of the state of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.medianBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the median value of the state of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.medianSince
(Item item, ZonedDateTime timestamp) Gets the median value of the state of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.medianSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the median value of the state of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.medianUntil
(Item item, ZonedDateTime timestamp) Gets the median value of the state of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.medianUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the median value of the state of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the Riemann sum of the states of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.riemannSumBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the Riemann sum of the states of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.riemannSumBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type) Gets the Riemann sum of the states of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.riemannSumBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the Riemann sum of the states of a givenItem
between two certain points in time.static @Nullable State
PersistenceExtensions.riemannSumSince
(Item item, ZonedDateTime timestamp) Gets the Riemann sum of the states of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the Riemann sum of the states of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the Riemann sum of the states of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the Riemann sum of the states of a givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumUntil
(Item item, ZonedDateTime timestamp) Gets the Riemann sum of the states of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the Riemann sum of the states of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the Riemann sum of the states of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.riemannSumUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the Riemann sum of the states of a givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.sumBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the sum of the state of a givenitem
between two certain points in time.static @Nullable State
PersistenceExtensions.sumBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the sum of the state of a givenitem
between two certain points in time.static @Nullable State
PersistenceExtensions.sumSince
(Item item, ZonedDateTime timestamp) Gets the sum of the state of a givenitem
since a certain point in time.static @Nullable State
PersistenceExtensions.sumSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the sum of the state of a givenitem
since a certain point in time.static @Nullable State
PersistenceExtensions.sumUntil
(Item item, ZonedDateTime timestamp) Gets the sum of the state of a givenitem
until a certain point in time.static @Nullable State
PersistenceExtensions.sumUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the sum of the state of a givenitem
until a certain point in time.static @Nullable State
PersistenceExtensions.varianceBetween
(Item item, ZonedDateTime begin, ZonedDateTime end) Gets the variance of the state of the givenItem
between two certain point in time.static @Nullable State
PersistenceExtensions.varianceBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable String serviceId) Gets the variance of the state of the givenItem
between two points in time.static @Nullable State
PersistenceExtensions.varianceBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type) Gets the variance of the state of the givenItem
between two certain point in time.static @Nullable State
PersistenceExtensions.varianceBetween
(Item item, ZonedDateTime begin, ZonedDateTime end, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the variance of the state of the givenItem
between two points in time.static @Nullable State
PersistenceExtensions.varianceSince
(Item item, ZonedDateTime timestamp) Gets the variance of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.varianceSince
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the variance of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.varianceSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the variance of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.varianceSince
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the variance of the state of the givenItem
since a certain point in time.static @Nullable State
PersistenceExtensions.varianceUntil
(Item item, ZonedDateTime timestamp) Gets the variance of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.varianceUntil
(Item item, ZonedDateTime timestamp, @Nullable String serviceId) Gets the variance of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.varianceUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type) Gets the variance of the state of the givenItem
until a certain point in time.static @Nullable State
PersistenceExtensions.varianceUntil
(Item item, ZonedDateTime timestamp, @Nullable PersistenceExtensions.RiemannType type, @Nullable String serviceId) Gets the variance of the state of the givenItem
until a certain point in time.Methods in org.openhab.core.persistence.extensions with parameters of type StateModifier and TypeMethodDescriptionstatic void
PersistenceExtensions.persist
(Item item, ZonedDateTime timestamp, State state) Persists astate
at a giventimestamp
of anitem
through the default persistence service.static void
PersistenceExtensions.persist
(Item item, ZonedDateTime timestamp, State state, @Nullable String serviceId) Persists astate
at a giventimestamp
of anitem
through aPersistenceService
identified by theserviceId
. -
Uses of State in org.openhab.core.thing.binding
Methods in org.openhab.core.thing.binding with parameters of type StateModifier and TypeMethodDescriptionvoid
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 StateModifier and TypeMethodDescription@Nullable State
ChannelValueConverterConfig.fixedValueToState
(String string) maps a user-defined string to a stateMethod parameters in org.openhab.core.thing.binding.generic with type arguments of type StateModifier and TypeMethodDescriptionChannelHandler.Factory.create
(Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, 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 StateModifier and TypeMethodDescriptionConstructor parameters in org.openhab.core.thing.binding.generic.converter with type arguments of type StateModifierConstructorDescriptionColorChannelHandler
(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 StateModifier and TypeMethodDescriptionProfileContext.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 StateModifier and TypeMethodDescriptionvoid
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 StateModifier and TypeClassDescriptionenum
There are situations when item states do not have any defined value.Methods in org.openhab.core.types with type parameters of type StateModifier and TypeMethodDescriptiondefault <T extends @Nullable State>
@Nullable TConvert thisState
's value into another typeMethods in org.openhab.core.types that return StateModifier and TypeMethodDescriptionstatic @Nullable State
TypeParser.parseState
(List<Class<? extends State>> types, String s) Determines a state from a string.TimeSeries.Entry.state()
Returns the value of thestate
record component.Methods in org.openhab.core.types with parameters of type StateModifier and TypeMethodDescriptionvoid
Add a new element to this series.Method parameters in org.openhab.core.types with type arguments of type StateModifier and TypeMethodDescriptionstatic @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 -
Uses of State in org.openhab.core.ui.items
Methods in org.openhab.core.ui.items that return StateModifier and TypeMethodDescription@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
Retrieves the current state of the item of a widget orUnDefType.UNDEF
.Methods in org.openhab.core.ui.items with parameters of type StateModifier and TypeMethodDescription@Nullable State
ItemUIRegistry.convertState
(Widget widget, Item item, State state) Convert the given state into