Package com.github.thought2code.mcp.annotated.common

Record Class Immutable<T>

java.lang.Object
java.lang.Record
com.github.thought2code.mcp.annotated.common.Immutable<T>
Type Parameters:
T - the type of the value
public record Immutable<T>(T value) extends Record
A simple immutable wrapper class for a single value. Instances of this class are immutable, meaning that once created, their value cannot be changed.
Author:
codeboyzhou

  • Constructor Summary

    Constructors
    Constructor
    Description
    Immutable(T value)
    Creates an instance of a Immutable record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    T
    get()
    Returns the value wrapped by this Immutable instance.
    final int
    hashCode()
    Returns a hash code value for this object.
    static <T> Immutable<T>
    of(T value)
    Creates a new instance of Immutable with the specified value.
    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 java.lang.Object

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

  • Constructor Details

    • Immutable

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

  • Method Details

    • of

      public static <T> Immutable<T> of(T value)
      Creates a new instance of Immutable with the specified value.
      Type Parameters:
      T - the type of the value
      Parameters:
      value - the value to be wrapped
      Returns:
      a new instance of Immutable with the specified value

    • get

      public T get()
      Returns the value wrapped by this Immutable instance. It can also use value() to get the value, but #get() is more readable.
      Returns:
      the value wrapped by this Immutable instance

    • 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