Package org.openhab.core.items

Class GroupItem

java.lang.Object

org.openhab.core.items.GenericItem

org.openhab.core.items.GroupItem

All Implemented Interfaces:

Identifiable<String>, ActiveItem, Item, MetadataAwareItem, StateChangeListener

@NonNullByDefault
public class GroupItem
extends GenericItem
implements StateChangeListener, MetadataAwareItem

Author:

Kai Kreuzer - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Nullable Item	baseItem
protected @Nullable GroupFunction	function
protected final CopyOnWriteArrayList<Item>	members
static final String	TYPE

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
GroupItem(String name)	Creates a plain GroupItem
GroupItem(String name, @Nullable Item baseItem)
GroupItem(String name, @Nullable Item baseItem, @Nullable GroupFunction function)	Creates a GroupItem with function

Method Summary

Modifier and Type	Method	Description
void	addedMetadata(Metadata metadata)	Can be implemented by subclasses to be informed about added metadata
void	addMember(Item item)	Adds the given item to the members of this group item.
void	dispose()	Disposes this item.
List<Class<? extends Command>>	getAcceptedCommandTypes()	The accepted command types of a group item is the same as of the underlying base item.
List<Class<? extends State>>	getAcceptedDataTypes()	The accepted data types of a group item is the same as of the underlying base item.
Set<Item>	getAllMembers()	Returns the direct members of this GroupItem and recursively all members of the potentially contained GroupItems as well.
Set<Item>	getAllStateMembers()	Returns the direct members of this GroupItem and recursively all members of the potentially contained GroupItems as well.
@Nullable Item	getBaseItem()	Returns the base item of this GroupItem.
@Nullable GroupFunction	getFunction()	Returns the function of this GroupItem.
Set<Item>	getMembers()	Returns the direct members of this GroupItem regardless if these members are GroupItems as well.
Set<Item>	getMembers(Predicate<Item> filterItem)	Retrieves ALL members of this group and filters it with the given Predicate
<T extends State> @Nullable T	getStateAs(Class<T> typeClass)	returns the current state of the item as a specific type
protected void	internalSend(Command command, @Nullable String source)
void	removeAllMembers()	Removes all items from the members of this group item.
void	removedMetadata(Metadata metadata)	Can be implemented by subclasses to be informed about removed metadata
void	removeMember(Item item)	Removes the given item from the members of this group item.
void	replaceMember(Item oldItem, Item newItem)
void	send(Command command)	Send a command to the each member of the group.
void	send(Command command, @Nullable String source)	Send a command to the each member of the group.
void	setCommandDescriptionService(@Nullable CommandDescriptionService commandDescriptionService)
void	setState(State state, @Nullable String source)	Set a new state.
void	setStateDescriptionService(@Nullable StateDescriptionService stateDescriptionService)
void	stateChanged(Item item, State oldState, State newState)	This method is called, if a state has changed.
void	stateUpdated(Item item, State state)	This method is called, if a state was updated, but has not changed
String	toString()
void	updatedMetadata(Metadata oldMetadata, Metadata newMetadata)	Can be implemented by subclasses to be informed about updated metadata

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

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

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

baseItem

protected final @Nullable Item baseItem

function

protected @Nullable GroupFunction function

members

protected final CopyOnWriteArrayList<Item> members

Constructor Details

GroupItem

public GroupItem(String name)

Creates a plain GroupItem

Parameters:

name - name of the group

GroupItem

public GroupItem(String name,
 @Nullable Item baseItem)

GroupItem

public GroupItem(String name,
 @Nullable Item baseItem,
 @Nullable GroupFunction function)

Creates a GroupItem with function

Parameters:

name - name of the group

baseItem - type of items in the group

function - function to calculate group status out of member status

Method Details

dispose

public void dispose()

Description copied from class: GenericItem

Disposes this item. Clears all injected services and unregisters all change listeners. This does not remove this item from its groups. Removing from groups should be done externally to retain the member order in case this item is exchanged in a group.

Overrides:

dispose in class GenericItem

getBaseItem

public @Nullable Item getBaseItem()

Returns the base item of this GroupItem. This method is only intended to allow instance checks of the underlying BaseItem. It must not be changed in any way.

Returns:

the base item of this GroupItem

getFunction

public @Nullable GroupFunction getFunction()

Returns the function of this GroupItem.

Returns:

the function of this GroupItem

getMembers

public Set<Item> getMembers()

Returns the direct members of this GroupItem regardless if these members are GroupItems as well.

Returns:

the direct members of this GroupItem

getAllMembers

public Set<Item> getAllMembers()

Returns the direct members of this GroupItem and recursively all members of the potentially contained GroupItems as well. The GroupItems itself aren't contained. The returned items are unique.

Returns:

all members of this and all contained GroupItems

getAllStateMembers

public Set<Item> getAllStateMembers()

Returns the direct members of this GroupItem and recursively all members of the potentially contained GroupItems as well. The GroupItems itself are contained if they can have a state. The returned items are unique.

Returns:

all members of this and all contained GroupItems

getMembers

public Set<Item> getMembers(Predicate<Item> filterItem)

Retrieves ALL members of this group and filters it with the given Predicate

Parameters:

filterItem - Predicate with settings to filter member list

Returns:

Set of member items filtered by filterItem

addMember

public void addMember(Item item)

Adds the given item to the members of this group item.

Parameters:

item - the item to be added (must not be null)

Throws:

IllegalArgumentException - if the given item is null

replaceMember

public void replaceMember(Item oldItem,
 Item newItem)

removeMember

public void removeMember(Item item)

Removes the given item from the members of this group item.

Parameters:

item - the item to be removed (must not be null)

Throws:

IllegalArgumentException - if the given item is null

removeAllMembers

public void removeAllMembers()

Removes all items from the members of this group item.

getAcceptedDataTypes

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

The accepted data types of a group item is the same as of the underlying base item. If none is defined, the intersection of all sets of accepted data types of all group members is used instead.

Specified by:

getAcceptedDataTypes in interface Item

Returns:

the accepted data types of this group item

getAcceptedCommandTypes

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

The accepted command types of a group item is the same as of the underlying base item. If none is defined, the intersection of all sets of accepted command types of all group members is used instead.

Specified by:

getAcceptedCommandTypes in interface Item

Returns:

the accepted command types of this group item

send

public void send(Command command)

Send a command to the each member of the group.

Parameters:

command - the command to be sent

send

public void send(Command command,
 @Nullable String source)

Send a command to the each member of the group.

Parameters:

command - the command to be sent

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

internalSend

protected void internalSend(Command command,
 @Nullable String source)

Overrides:

internalSend in class GenericItem

getStateAs

public <T extends State> @Nullable T getStateAs(Class<T> typeClass)

Description copied from interface: Item

returns the current state of the item as a specific type

Specified by:

getStateAs in interface Item

Overrides:

getStateAs in class GenericItem

Returns:

the current state in the requested type or null, if state cannot be provided as the requested type

toString

public String toString()

Overrides:

toString in class GenericItem

stateChanged

public void stateChanged(Item item,
 State oldState,
 State newState)

Description copied from interface: StateChangeListener

This method is called, if a state has changed.

Specified by:

stateChanged in interface StateChangeListener

Parameters:

item - the item whose state has changed

oldState - the previous state

newState - the new state

stateUpdated

public void stateUpdated(Item item,
 State state)

Description copied from interface: StateChangeListener

This method is called, if a state was updated, but has not changed

Specified by:

stateUpdated in interface StateChangeListener

Parameters:

item - the item whose state was updated

state - the current state, same before and after the update

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

setStateDescriptionService

public void setStateDescriptionService(@Nullable StateDescriptionService stateDescriptionService)

Overrides:

setStateDescriptionService in class GenericItem

setCommandDescriptionService

public void setCommandDescriptionService(@Nullable CommandDescriptionService commandDescriptionService)

Overrides:

setCommandDescriptionService in class GenericItem

addedMetadata

public void addedMetadata(Metadata metadata)

Description copied from interface: MetadataAwareItem

Can be implemented by subclasses to be informed about added metadata

Specified by:

addedMetadata in interface MetadataAwareItem

Parameters:

metadata - the added Metadata object for this Item

updatedMetadata

public void updatedMetadata(Metadata oldMetadata,
 Metadata newMetadata)

Description copied from interface: MetadataAwareItem

Can be implemented by subclasses to be informed about updated metadata

Specified by:

updatedMetadata in interface MetadataAwareItem

Parameters:

oldMetadata - the old Metadata object for this Item

newMetadata - the new Metadata object for this Item

removedMetadata

public void removedMetadata(Metadata metadata)

Description copied from interface: MetadataAwareItem

Can be implemented by subclasses to be informed about removed metadata

Specified by:

removedMetadata in interface MetadataAwareItem

Parameters:

metadata - the removed Metadata object for this Item