Record Class Attribute<T>

java.lang.Object
java.lang.Record
fr.fidorial.world.environment.Attribute<T>
Type Parameters:
T - the value type
Record Components:
value - the value, or the modifier argument when modifier is not Modifier.OVERRIDE
modifier - how the value combines with the one already provided
public record Attribute<T>(T value, Modifier modifier) extends Record
One environment attribute value, together with the way it combines with the dimension's value.
Since:
0.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Attribute(T value, Modifier modifier)
    Creates an instance of a Attribute record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    Modifier
    modifier()
    Returns the value of the modifier record component.
    static <T> Attribute<T>
    of(T value)
    Creates an attribute replacing whatever the dimension provided.
    static <T> Attribute<T>
    of(T value, Modifier modifier)
    Creates an attribute deriving from whatever the dimension provided.
    final String
    toString()
    Returns a string representation of this record class.
    T
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

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

  • Constructor Details

    • Attribute

      public Attribute(T value, Modifier modifier)
      Creates an instance of a Attribute record class.
      Parameters:
      value - the value for the value record component
      modifier - the value for the modifier record component

  • Method Details

    • of

      @Contract(value="_ -> new", pure=true) public static <T> Attribute<T> of(T value)
      Creates an attribute replacing whatever the dimension provided.
      Type Parameters:
      T - the value type
      Parameters:
      value - the value
      Returns:
      the attribute

    • of

      @Contract(value="_, _ -> new", pure=true) public static <T> Attribute<T> of(T value, Modifier modifier)
      Creates an attribute deriving from whatever the dimension provided.
      Type Parameters:
      T - the value type
      Parameters:
      value - the modifier argument
      modifier - how to combine it
      Returns:
      the attribute

    • 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 Objects::equals(Object,Object).
      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 T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • modifier

      public Modifier modifier()
      Returns the value of the modifier record component.
      Returns:
      the value of the modifier record component