Record Class DialogInput.Bool

java.lang.Object
java.lang.Record
fr.fidorial.dialog.DialogInput.Bool
Record Components:
key - the identifier the value is sent under
label - the label displayed to the left of the checkbox
initial - whether the box starts checked
onTrue - the string sent while the box is checked
onFalse - the string sent while the box is unchecked
All Implemented Interfaces:
DialogInput
Enclosing interface:
DialogInput
public static record DialogInput.Bool(String key, Component label, boolean initial, String onTrue, String onFalse) extends Record implements DialogInput
A checkbox, mapping to the vanilla minecraft:boolean control.
Since:
0.1.0

  • Constructor Details

    • Bool

      public Bool(String key, Component label, boolean initial, String onTrue, String onFalse)
      Creates an instance of a Bool record class.
      Parameters:
      key - the value for the key record component
      label - the value for the label record component
      initial - the value for the initial record component
      onTrue - the value for the onTrue record component
      onFalse - the value for the onFalse record component

  • Method Details

    • initial

      @Contract("_ -> new") public DialogInput.Bool initial(boolean initial)
      Parameters:
      initial - whether the box starts checked
      Returns:
      a copy of this control starting in the given state
      Since:
      0.1.0

    • values

      @Contract("_, _ -> new") public DialogInput.Bool values(String onTrue, String onFalse)
      Parameters:
      onTrue - the string sent while the box is checked
      onFalse - the string sent while the box is unchecked
      Returns:
      a copy of this control sending the given values
      Since:
      0.1.0

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public String key()
      Returns the value of the key record component.
      Specified by:
      key in interface DialogInput
      Returns:
      the value of the key record component

    • label

      public Component label()
      Returns the value of the label record component.
      Specified by:
      label in interface DialogInput
      Returns:
      the value of the label record component

    • initial

      public boolean initial()
      Returns the value of the initial record component.
      Returns:
      the value of the initial record component

    • onTrue

      public String onTrue()
      Returns the value of the onTrue record component.
      Returns:
      the value of the onTrue record component

    • onFalse

      public String onFalse()
      Returns the value of the onFalse record component.
      Returns:
      the value of the onFalse record component