Package io.github.zeroone3010.yahueapi

Interface StateBuilderSteps.OnOffStep

All Known Subinterfaces:
StateBuilderSteps.BuildStep
All Known Implementing Classes:
State.Builder
Enclosing class:
StateBuilderSteps
public static interface StateBuilderSteps.OnOffStep

  • Method Summary

    Modifier and Type Method Description
    default State keepCurrentState()
    Keeps the current state of the light to which this state is assigned: if it's on, it stays on, and if it's off, it stays off.
    default State off()
    Deprecated. 
    default State on()
    Deprecated. 
    State on​(Boolean on)
    Deprecated. 

  • Method Details

    • on

      State on​(Boolean on)
      Deprecated.
      Parameters:
      on - Toggles the light on (true) or off (false).
      Returns:
      A new State.
      See Also:
      UpdateState.on(boolean)

    • on

      default State on()
      Deprecated.
      Creates a new State that will turn on the light to which it is assigned. A shorthand method for on(true). Avoid calling in vain if you know the light is on already.
      Returns:
      A new State.
      See Also:
      UpdateState.on()

    • off

      default State off()
      Deprecated.
      Creates a new State that will turn off the light to which it is assigned. A shorthand method for on(false).
      Returns:
      A new State.
      See Also:
      UpdateState.off()

    • keepCurrentState

      default State keepCurrentState()
      Keeps the current state of the light to which this state is assigned: if it's on, it stays on, and if it's off, it stays off. A shorthand method for on(null).
      Returns:
      A new State.