Package com.github.siroshun09.configapi.core.node

Record Class BooleanValue

java.lang.Object
java.lang.Record
com.github.siroshun09.configapi.core.node.BooleanValue
Record Components:
booleanValue - a boolean
All Implemented Interfaces:
Node<Boolean>, StringRepresentable, ValueNode<Boolean>
public record BooleanValue(boolean booleanValue) extends Record implements ValueNode<Boolean>, StringRepresentable
A Node implementation that holds a boolean value.

  • Field Details

  • Constructor Details

  • Method Details

    • fromBoolean

      @NotNull public static @NotNull BooleanValue fromBoolean(@Nullable @Nullable Boolean bool)
      Creates a BooleanValue from the given Boolean.
      Parameters:
      bool - a Boolean to create BooleanValue
      Returns:
      TRUE if the given Boolean equals Boolean.TRUE, otherwise FALSE

    • fromBoolean

      @NotNull public static @NotNull BooleanValue fromBoolean(boolean bool)
      Creates a BooleanValue from the given boolean.
      Parameters:
      bool - a boolean to create BooleanValue
      Returns:
      TRUE if the given boolean is true, otherwise FALSE

    • value

      @NotNull public @NotNull Boolean value()
      Description copied from interface: Node
      Gets an object which this Node holds
      Specified by:
      value in interface Node<Boolean>
      Specified by:
      value in interface ValueNode<Boolean>
      Returns:
      an object which this Node holds

    • hasValue

      public boolean hasValue()
      Description copied from interface: Node
      Checks if this Node holds an object.

      The default implementation of this method checks if the returning value from Node.value() is not null.

      Specified by:
      hasValue in interface Node<Boolean>
      Returns:
      true if this Node holds an object, otherwise false

    • asBoolean

      public boolean asBoolean()
      Gets the value as a primitive boolean.

      This method returns the same value as booleanValue().

      Returns:
      a primitive boolean

    • accept

      @NotNull public @NotNull VisitResult accept(@NotNull @NotNull NodeVisitor visitor)
      Description copied from interface: Node
      Accepts a NodeVisitor for this Node.
      Specified by:
      accept in interface Node<Boolean>
      Parameters:
      visitor - a NodeVisitor to accept
      Returns:
      a VisitResult

    • asString

      @NotNull public @NotNull String asString()
      Description copied from interface: StringRepresentable
      Represents as a String.
      Specified by:
      asString in interface StringRepresentable
      Returns:
      a String representation of this node

    • 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. All components in this record class are compared with '=='.
      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.

    • booleanValue

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