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.TransitionTimeStep, StateBuilderSteps.XyStep

Enclosing class:

State

public static final class State.Builder
extends 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(Color color)	Color.
StateBuilderSteps.BuildStep	color(String color)	Color.
StateBuilderSteps.BrightnessStep	colorTemperatureInMireks(int colorTemperature)	Color temperature.
StateBuilderSteps.SaturationStep	hue(int hue)	Hue.
State	on(Boolean on)
StateBuilderSteps.BrightnessStep	saturation(int saturation)	Saturation.
StateBuilderSteps.OnOffStep	transitionTime(int tenths)	Transition time.
StateBuilderSteps.BrightnessStep	xy(List<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 Detail

Builder

public Builder()

Method Detail

hue

public StateBuilderSteps.SaturationStep hue(int hue)

Description copied from interface: StateBuilderSteps.HueStep

Hue.

Specified by:

hue in interface StateBuilderSteps.HueStep

Parameters:

hue - A value from 0 to 65280.

Returns:

The next step of this state builder

saturation

public StateBuilderSteps.BrightnessStep saturation(int saturation)

Description copied from interface: StateBuilderSteps.SaturationStep

Saturation.

Specified by:

saturation in interface StateBuilderSteps.SaturationStep

Parameters:

saturation - A value from 0 (white) to 254 (most saturated).

Returns:

The next step of this state builder

brightness

public StateBuilderSteps.BuildStep brightness(int brightness)

Description copied from interface: StateBuilderSteps.BrightnessStep

Brightness.

Specified by:

brightness in interface StateBuilderSteps.BrightnessStep

Parameters:

brightness - A value from 1 (minimum brightness) to 254 (maximum brightness).

Returns:

The next step of this state builder

xy

public StateBuilderSteps.BrightnessStep xy(List<Float> xy)

Description copied from interface: StateBuilderSteps.XyStep

Color.

Specified by:

xy in interface StateBuilderSteps.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

public StateBuilderSteps.BuildStep color(Color color)

Description copied from interface: StateBuilderSteps.ColorStep

Color.

Specified by:

color in interface StateBuilderSteps.ColorStep

Parameters:

color - The color as a Color object.

Returns:

The next step of this state builder

color

public StateBuilderSteps.BuildStep color(String color)

Description copied from interface: StateBuilderSteps.ColorStep

Color.

Specified by:

color in interface StateBuilderSteps.ColorStep

Parameters:

color - The color as a hexadecimal string, for example "#ff0000" for red.

Returns:

The next step of this state builder

colorTemperatureInMireks

public StateBuilderSteps.BrightnessStep colorTemperatureInMireks(int colorTemperature)

Description copied from interface: StateBuilderSteps.ColorTemperatureStep

Color temperature.

Specified by:

colorTemperatureInMireks in interface StateBuilderSteps.ColorTemperatureStep

Parameters:

colorTemperature - The color temperature in mireks. Must be between 153 (6500K) and 500 (2000K)

Returns:

The next step of this state builder

transitionTime

public StateBuilderSteps.OnOffStep transitionTime(int tenths)

Description copied from interface: StateBuilderSteps.TransitionTimeStep

Transition time.

Specified by:

transitionTime in interface StateBuilderSteps.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

public State on(Boolean on)

Specified by:

on in interface StateBuilderSteps.OnOffStep