Package org.openhab.core.library.types

Class ArithmeticGroupFunction.Or

java.lang.Object

org.openhab.core.library.types.ArithmeticGroupFunction.Or

All Implemented Interfaces:

GroupFunction

Direct Known Subclasses:

ArithmeticGroupFunction.NOr

Enclosing interface:

ArithmeticGroupFunction

public static class ArithmeticGroupFunction.Or
extends Object
implements GroupFunction

This does a logical 'or' operation. If at least one item is of 'activeState' this is returned, otherwise the 'passiveState' is returned. Through the getStateAs() method, it can be determined, how many items actually are in the 'activeState'.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openhab.core.items.GroupFunction

GroupFunction.Equality

Field Summary

Fields

Modifier and Type	Field	Description
protected final State	activeState
protected final State	passiveState

Constructor Summary

Constructors

Constructor	Description
Or(@Nullable State activeValue, @Nullable State passiveValue)

Method Summary

Modifier and Type	Method	Description
State	calculate(@Nullable Set<Item> items)	Determines the current state of a group based on a list of items
State[]	getParameters()	Returns the parameters of the function as an array.
<T extends State> @Nullable T	getStateAs(@Nullable Set<Item> items, Class<T> stateClass)	Calculates the group state and returns it as a state of the requested type.

Methods inherited from class java.lang.Object

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

Field Details

activeState

protected final State activeState

passiveState

protected final State passiveState

Constructor Details

Or

public Or(@Nullable State activeValue,
 @Nullable State passiveValue)

Method Details

calculate

public State calculate(@Nullable Set<Item> items)

Description copied from interface: GroupFunction

Determines the current state of a group based on a list of items

Specified by:

calculate in interface GroupFunction

Parameters:

items - the items to calculate a group state for

Returns:

the calculated group state

getStateAs

public <T extends State> @Nullable T getStateAs(@Nullable Set<Item> items,
 Class<T> stateClass)

Description copied from interface: GroupFunction

Calculates the group state and returns it as a state of the requested type.

Specified by:

getStateAs in interface GroupFunction

Parameters:

items - the items to calculate a group state for

stateClass - the type in which the state should be returned

Returns:

the calculated group state of the requested type or null, if type is not supported

getParameters

public State[] getParameters()

Description copied from interface: GroupFunction

Returns the parameters of the function as an array.

Specified by:

getParameters in interface GroupFunction

Returns:

the parameters of this function