de.toman.milight

Class LightObserver

java.lang.Object

de.toman.milight.LightObserver

public class LightObserver
extends java.lang.Object

This class stores the current state of a given group of lights and adjusts this state each time it changes. It listens to the LightEvent instances fired and is therefore only notified if commands are send to the group of lights via this API and not via remote control or other controllers.

Constructor Summary

Constructors

Constructor and Description
LightObserver(Lights lights) This constructor creates a new LightOberserver storing the current and last state of a given group of lights.

Method Summary

Modifier and Type	Method and Description
LightState	getCurrentState() This funtion returns the current state of the observed group of lights.
LightState	getLastState() This funtion returns the last state of the observed group of lights (i.e.
Lights	getLights() This function returns the group of lights observed.
java.util.Stack<LightState>	getStates() This function returns a stack of all known states, beginning with the current one.
void	restore() This function removes the youngest state from the stack and restores it to the group of lights observerd by this instance.
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

LightObserver

public LightObserver(Lights lights)

This constructor creates a new LightOberserver storing the current and last state of a given group of lights. The state will be recorded autmotically, you don't need to call another command than this one.

Parameters:

lights - the group of lights to observe

Method Detail

getCurrentState

public LightState getCurrentState()

This funtion returns the current state of the observed group of lights.

Returns:

the current state of the observed group of lights

getStates

public java.util.Stack<LightState> getStates()

This function returns a stack of all known states, beginning with the current one.

Returns:

a stack of all known states, beginning with the current one.

getLastState

public LightState getLastState()
                        throws java.util.EmptyStackException

This funtion returns the last state of the observed group of lights (i.e. the current state before the last command was sent to them).

Returns:

the last state of the observed group of lights or null if there is no known history

Throws:

java.util.EmptyStackException - if the stack of states is empty

restore

public void restore()
             throws java.io.IOException,
                    java.util.EmptyStackException

This function removes the youngest state from the stack and restores it to the group of lights observerd by this instance.

Throws:

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

java.util.EmptyStackException - if the stack of states is empty

getLights

public Lights getLights()

This function returns the group of lights observed.

Returns:

the group of lights observed

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