Package net.mezzdev.config.api.value.serializer

Record Class ConfigValueRange<T>

java.lang.Object
java.lang.Record
net.mezzdev.config.api.value.serializer.ConfigValueRange<T>
Record Components:
min - smallest valid value
max - largest valid value
public record ConfigValueRange<T>(T min, T max) extends Record
Inclusive lower and upper bounds for a config value.

Returned by IConfigValueSerializer.getRange() when a config value should be edited as a bounded range.

Since:
0.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigValueRange(T min, T max)
    Validate and create an inclusive config value range.

  • 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.
    T
    max()
    Returns the value of the max record component.
    T
    min()
    Returns the value of the min record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigValueRange

      public ConfigValueRange(T min, T max)
      Validate and create an inclusive config value range.
      Parameters:
      min - smallest valid value
      max - largest valid value
      Since:
      0.1.0

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

    • min

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

    • max

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