de.toman.milight.events

Class ChangeBrightnessEvent

java.lang.Object

java.util.EventObject

de.toman.milight.events.LightEvent

de.toman.milight.events.ChangeBrightnessEvent

All Implemented Interfaces:

java.io.Serializable

public class ChangeBrightnessEvent
extends LightEvent

An instance of this class is fired by Lights instances when the group of lights is switched to another brightness level.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ChangeBrightnessEvent(Lights lights, float brightness) This constructor creates a new ChangeBrightnessEvent referencing to a group of light that was switched to a new brightness level.

Method Summary

Modifier and Type	Method and Description
float	getBrightness() This function returns the new new brightness level (between 0 and 1) for the group of lights.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeBrightnessEvent

public ChangeBrightnessEvent(Lights lights,
                             float brightness)

This constructor creates a new ChangeBrightnessEvent referencing to a group of light that was switched to a new brightness level.

Parameters:

lights - is the group of lights that was switched to white mode

brightness - is the new new brightness level (0 and 1)

Throws:

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

Method Detail

getBrightness

public float getBrightness()

This function returns the new new brightness level (between 0 and 1) for the group of lights.

Returns:

the new new brightness level (between 0 and 1) for the group of lights