Package io.github.zeroone3010.yahueapi
Class State.Builder
java.lang.Object
io.github.zeroone3010.yahueapi.State.Builder
- All Implemented Interfaces:
StateBuilderSteps.BrightnessStep
,StateBuilderSteps.BuildStep
,StateBuilderSteps.ColorStep
,StateBuilderSteps.ColorTemperatureStep
,StateBuilderSteps.HueStep
,StateBuilderSteps.InitialStep
,StateBuilderSteps.OnOffStep
,StateBuilderSteps.SaturationStep
,StateBuilderSteps.SceneStep
,StateBuilderSteps.TransitionTimeStep
,StateBuilderSteps.XyStep
- Enclosing class:
- State
public static final class State.Builder extends java.lang.Object implements StateBuilderSteps.InitialStep, StateBuilderSteps.HueStep, StateBuilderSteps.SaturationStep, StateBuilderSteps.BrightnessStep, StateBuilderSteps.XyStep, StateBuilderSteps.ColorStep, StateBuilderSteps.ColorTemperatureStep, StateBuilderSteps.TransitionTimeStep, StateBuilderSteps.BuildStep, StateBuilderSteps.OnOffStep
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description StateBuilderSteps.BuildStep
brightness(int brightness)
Brightness.StateBuilderSteps.BuildStep
color(java.awt.Color color)
Color.StateBuilderSteps.BuildStep
color(java.lang.String color)
Color.StateBuilderSteps.BrightnessStep
colorTemperatureInMireks(int colorTemperature)
Color temperature.StateBuilderSteps.SaturationStep
hue(int hue)
Hue.State
on(java.lang.Boolean on)
StateBuilderSteps.BrightnessStep
saturation(int saturation)
Saturation.StateBuilderSteps.BuildStep
scene(java.lang.String scene)
Scene.StateBuilderSteps.OnOffStep
transitionTime(int tenths)
Transition time.StateBuilderSteps.BrightnessStep
xy(java.util.List<java.lang.Float> xy)
Color.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.github.zeroone3010.yahueapi.StateBuilderSteps.OnOffStep
keepCurrentState, off, on
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
hue
Description copied from interface:StateBuilderSteps.HueStep
Hue.- Specified by:
hue
in interfaceStateBuilderSteps.HueStep
- Parameters:
hue
- A value from0
to65280
.- Returns:
- The next step of this state builder
-
saturation
Description copied from interface:StateBuilderSteps.SaturationStep
Saturation.- Specified by:
saturation
in interfaceStateBuilderSteps.SaturationStep
- Parameters:
saturation
- A value from 0 (white) to 254 (most saturated).- Returns:
- The next step of this state builder
-
brightness
Description copied from interface:StateBuilderSteps.BrightnessStep
Brightness.- Specified by:
brightness
in interfaceStateBuilderSteps.BrightnessStep
- Parameters:
brightness
- A value from1
(minimum brightness) to254
(maximum brightness).- Returns:
- The next step of this state builder
-
xy
Description copied from interface:StateBuilderSteps.XyStep
Color.- Specified by:
xy
in interfaceStateBuilderSteps.XyStep
- Parameters:
xy
- The x and y coordinates of the C.I.E. chromaticity diagram. Exactly two values between 0 and 1 required.- Returns:
- The next step of this state builder
-
color
Description copied from interface:StateBuilderSteps.ColorStep
Color.- Specified by:
color
in interfaceStateBuilderSteps.ColorStep
- Parameters:
color
- The color as aColor
object.- Returns:
- The next step of this state builder
-
color
Description copied from interface:StateBuilderSteps.ColorStep
Color.- Specified by:
color
in interfaceStateBuilderSteps.ColorStep
- Parameters:
color
- The color as a hexadecimal string, for example "#ff0000" for red.- Returns:
- The next step of this state builder
-
colorTemperatureInMireks
Description copied from interface:StateBuilderSteps.ColorTemperatureStep
Color temperature.- Specified by:
colorTemperatureInMireks
in interfaceStateBuilderSteps.ColorTemperatureStep
- Parameters:
colorTemperature
- The color temperature in mireks. Must be between153
(6500K) and500
(2000K)- Returns:
- The next step of this state builder
-
transitionTime
Description copied from interface:StateBuilderSteps.TransitionTimeStep
Transition time.- Specified by:
transitionTime
in interfaceStateBuilderSteps.TransitionTimeStep
- Parameters:
tenths
- Transition time in tenths of seconds, i.e. "4" equals "0.4 seconds".- Returns:
- The next step of this state builder
-
on
- Specified by:
on
in interfaceStateBuilderSteps.OnOffStep
-
scene
Description copied from interface:StateBuilderSteps.SceneStep
Scene.- Specified by:
scene
in interfaceStateBuilderSteps.SceneStep
- Parameters:
scene
- An identifier of a scene to be activated.- Returns:
- The next step of this state builder
-