de.toman.milight

Class LightState

java.lang.Object

de.toman.milight.LightState

public class LightState
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LightState(MilightColor color, float brightness, boolean whiteMode, boolean on) This constructor creates a new LightState instance which stores the state of a group of lights.

Method Summary

Modifier and Type	Method and Description
boolean	equals(LightState state) This function checks whether two LightStates represent the same state.
float	getBrightness() This function returns the brightness level between 0 and 1 currently displayed by the group of lights if they are in white mode.
MilightColor	getColor() This function returns the color which is currently display by the group of lights if the lights are in colored mode.
boolean	isOn() This function returns whether the group of lights is switched on.
boolean	isWhiteMode() This function returns whether the group of lights is in white mode.
void	restore(Lights lights) This function restores the state represented by this instance to a group of lights.
java.lang.String	toString() This function describes the objet as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

LightState

public LightState(MilightColor color,
                  float brightness,
                  boolean whiteMode,
                  boolean on)

This constructor creates a new LightState instance which stores the state of a group of lights.

Parameters:

color - is the color last displayed in colored mode

brightness - is the brightness value last displayed in white mode (between 0 and 1)

whiteMode - is true if the lights are currently in white mode and false if they are in colored mode

on - is true if the group of lights is switched on

Throws:

java.lang.IllegalArgumentException - if the brightness value is not between 0 and 1

Method Detail

getColor

public MilightColor getColor()

This function returns the color which is currently display by the group of lights if the lights are in colored mode. Otherwise, this is the color used last when the colored mode was activated

Returns:

the color displayed by the lights

See Also:

isWhiteMode()

isWhiteMode

public boolean isWhiteMode()

This function returns whether the group of lights is in white mode.

Returns:

true if the group of lights is in white mode, false if it uses the colored mode

getBrightness

public float getBrightness()

This function returns the brightness level between 0 and 1 currently displayed by the group of lights if they are in white mode. Otherwise, it is the brightness level used last when the lights were in white mode.

Returns:

the brightness level between 0 and 1

See Also:

isWhiteMode()

isOn

public boolean isOn()

This function returns whether the group of lights is switched on.

Returns:

true if the group of lights is switched on

equals

public boolean equals(LightState state)

This function checks whether two LightStates represent the same state.

Parameters:

state - the state to compare to

Returns:

true if both LightStates represent the same state, false otherwise

restore

public void restore(Lights lights)
             throws java.io.IOException

This function restores the state represented by this instance to a group of lights. Depending on the state, the group of lights is switched to colored resp. white mode and brightness/hue are adjusted.

Parameters:

lights - is the group of lights to be adjusted

Throws:

java.io.IOException - if the message could not be sent

toString

public java.lang.String toString()

This function describes the objet as a string. Use this for debugging.

Overrides:

toString in class java.lang.Object