Module net.luis.utils
Package net.luis.utils.lang

Record Class EnumConstant<T>

java.lang.Object
java.lang.Record
net.luis.utils.lang.EnumConstant<T>
Type Parameters:
T - The type of the enum constant
Record Components:
name - The name of the enum constant
ordinal - The ordinal of the enum constant
value - The value of the enum constant
public record EnumConstant<T>(@NotNull String name, int ordinal, T value) extends Record
A record that represents an enum constant.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final @NotNull String
    name
    The field for the name record component.
    private final int
    ordinal
    The field for the ordinal record component.
    private final T
    value
    The field for the value record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EnumConstant(@NotNull String name, int ordinal, T value)
    Constructs a new enum constant with the given name, ordinal and value.

  • 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.
    @NotNull String
    name()
    Returns the value of the name record component.
    int
    ordinal()
    Returns the value of the ordinal record component.
    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

  • Field Details

    • name

      @NotNull private final @NotNull String name
      The field for the name record component.

    • ordinal

      private final int ordinal
      The field for the ordinal record component.

    • value

      @NotNull private final T value
      The field for the value record component.

  • Constructor Details

    • EnumConstant

      public EnumConstant(@NotNull @NotNull String name, int ordinal, @NotNull T value)
      Constructs a new enum constant with the given name, ordinal and value.
      Parameters:
      name - The name of the enum constant
      ordinal - The ordinal of the enum constant
      value - The value of the enum constant
      Throws:
      NullPointerException - If the given name or value is null
      IllegalArgumentException - If the given ordinal is negative

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • name

      @NotNull public @NotNull String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • ordinal

      public int ordinal()
      Returns the value of the ordinal record component.
      Returns:
      the value of the ordinal record component

    • value

      @NotNull public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component