Module io.github.astrapisixtynine.design.patterns.state
Package io.github.astrapi69.design.pattern.state.wizard

Interface WizardState<ST>

Type Parameters:
ST - the generic type of the state machine
All Known Subinterfaces:
BaseWizardState<ST>
public interface WizardState<ST>
The interface WizardState represents a state in a wizard. This interface provides methods to manage the navigation and identification of different wizard states, including whether the state is the first, last, or has previous and next states.

  • Method Details

    • getName

      default String getName()
      Gets the simple name of this WizardState object. If a WizardStateInfo is present, it returns the name from it; otherwise, it returns the simple class name of this object.
      Returns:
      the simple name of this WizardState object

    • goNext

      void goNext(ST input)
      Go to the next WizardState object.
      Parameters:
      input - the WizardStateMachine object

    • goPrevious

      void goPrevious(ST input)
      Go to the previous WizardState object.
      Parameters:
      input - the WizardStateMachine object

    • hasNext

      default boolean hasNext()
      Checks if this WizardState object has a next WizardState object. If a WizardStateInfo is present, it returns the next flag from it; otherwise, it defaults to true.
      Returns:
      true if this WizardState object has a next WizardState object, otherwise false

    • hasPrevious

      default boolean hasPrevious()
      Checks if this WizardState object has a previous WizardState object. If a WizardStateInfo is present, it returns the previous flag from it; otherwise, it defaults to true.
      Returns:
      true if this WizardState object has a previous WizardState object, otherwise false

    • isFirst

      default boolean isFirst()
      Checks if this WizardState object is the first WizardState object. If a WizardStateInfo is present, it returns the first flag from it; otherwise, it defaults to false.
      Returns:
      true if this WizardState object is the first WizardState object, otherwise false

    • isLast

      default boolean isLast()
      Checks if this WizardState object is the last WizardState object. If a WizardStateInfo is present, it returns the last flag from it; otherwise, it defaults to false.
      Returns:
      true if this WizardState object is the last WizardState object, otherwise false

    • getWizardStateInfo

      WizardStateInfo getWizardStateInfo()
      Gets the WizardStateInfo object.
      Returns:
      the WizardStateInfo object

    • setWizardStateInfo

      void setWizardStateInfo(WizardStateInfo wizardStateInfo)
      Sets the new wizard state info object.
      Parameters:
      wizardStateInfo - the new wizard state info object

    • setNext

      default void setNext(boolean next)
      Sets the next flag.
      Parameters:
      next - the new next flag

    • setFirst

      default void setFirst(boolean first)
      Sets the first flag.
      Parameters:
      first - the new first flag

    • setLast

      default void setLast(boolean last)
      Sets the last flag.
      Parameters:
      last - the new last flag

    • setName

      default void setName(String name)
      Sets the name.
      Parameters:
      name - the new name

    • setPrevious

      default void setPrevious(boolean previous)
      Sets the previous flag.
      Parameters:
      previous - the new previous flag