Module com.darkcollective.relix.value
Package com.darkcollective.relix.value

Record Class BooleanValue

java.lang.Object
java.lang.Record
com.darkcollective.relix.value.BooleanValue
Record Components:
value - the boolean content
All Implemented Interfaces:
Value
public record BooleanValue(boolean value) extends Record implements Value
A runtime boolean value.

Prefer the constants TRUE and FALSE over the constructor to avoid unnecessary allocation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final BooleanValue
    FALSE
    The singleton false value.
    static final BooleanValue
    TRUE
    The singleton true value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BooleanValue(boolean value)
    Creates an instance of a BooleanValue record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asDisplayString()
    Returns a human-readable display string for this value, suitable for output formatting.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isNull()
    Returns true if this value is null (absent).
    static BooleanValue
    of(boolean value)
    Returns TRUE or FALSE for the given boolean.
    final String
    toString()
    Returns a string representation of this record class.
    ScalarType
    type()
    Returns the ScalarType that describes this value's kind.
    boolean
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • TRUE

      public static final BooleanValue TRUE
      The singleton true value.

    • FALSE

      public static final BooleanValue FALSE
      The singleton false value.

  • Constructor Details

    • BooleanValue

      public BooleanValue(boolean value)
      Creates an instance of a BooleanValue record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • of

      public static BooleanValue of(boolean value)
      Returns TRUE or FALSE for the given boolean.
      Parameters:
      value - the boolean
      Returns:
      the corresponding constant

    • isNull

      public boolean isNull()
      Description copied from interface: Value
      Returns true if this value is null (absent).
      Specified by:
      isNull in interface Value
      Returns:
      whether this is a NullValue

    • type

      public ScalarType type()
      Description copied from interface: Value
      Returns the ScalarType that describes this value's kind. NullValue returns ScalarType.ANY.
      Specified by:
      type in interface Value
      Returns:
      the scalar type

    • asDisplayString

      public String asDisplayString()
      Description copied from interface: Value
      Returns a human-readable display string for this value, suitable for output formatting. NullValue returns "NULL".
      Specified by:
      asDisplayString in interface Value
      Returns:
      display string; never null

    • 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.

    • value

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