Record Class BooleanValue

java.lang.Object
java.lang.Record
org.microbean.attributes.BooleanValue
Record Components:
value - the value
All Implemented Interfaces:
Comparable<BooleanValue>, Constable, Value<BooleanValue>
public record BooleanValue(boolean value) extends Record implements Value<BooleanValue>
A Value whose value is a boolean.
Author:
Laird Nelson

  • Field Details

  • 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

    • compareTo

      public final int compareTo(BooleanValue other)
      Specified by:
      compareTo in interface Comparable<BooleanValue>

    • describeConstable

      public final Optional<DynamicConstantDesc<BooleanValue>> describeConstable()
      Specified by:
      describeConstable in interface Constable

    • equals

      public final boolean equals(Object other)
      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 the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      other - the object with which to compare
      Returns:
      true if this object is the same as the other argument; false otherwise.

    • 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

    • 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

    • of

      public static final BooleanValue of(boolean b)
      Returns a BooleanValue suitable for the supplied arguments.
      Parameters:
      b - a boolean
      Returns:
      TRUE if b is true; FALSE otherwise

    • value

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