Package io.github.zeroone3010.yahueapi

Interface Room

public interface Room

A room or a zone that has been configured into the Hue Bridge.

Method Summary

Modifier and Type	Method	Description
Optional<Light>	getLightByName(String lightName)	Returns one light, if found by the given name.
Collection<Light>	getLights()	Returns all the lights that have been assigned to this room or zone.
String	getName()	Returns the name of the room or zone, as set by the user.
boolean	isAllOn()	Queries the state of the room or zone.
boolean	isAnyOn()	Queries the state of the room or zone.
void	setState(State state)	Sets a state for the room or zone.

Method Detail

getName

String getName()

Returns the name of the room or zone, as set by the user.

Returns:

Name of the room or zone.

getLights

Collection<Light> getLights()

Returns all the lights that have been assigned to this room or zone.

Returns:

A Collection of Light objects.

getLightByName

Optional<Light> getLightByName(String lightName)

Returns one light, if found by the given name.

Parameters:

lightName - Name of a light in this room or zone.

Returns:

Optional.empty() if a light is not found by this name, an Optional<Light> if it is.

isAnyOn

boolean isAnyOn()

Queries the state of the room or zone.

Returns:

True if any light is on in this room or zone, false if not.

isAllOn

boolean isAllOn()

Queries the state of the room or zone.

Returns:

True if all lights in this room or zone are on, false if they are not.

setState

void setState(State state)

Sets a state for the room or zone.

Parameters:

state - A state to be set for this room or zone.