Record Class TierDefinition

java.lang.Object
java.lang.Record
org.ppvon.ultimateCobblemonProgression.api.TierDefinition
Record Components:
index - the tier index (1-based)
levelCap - the level cap for the tier
species - the list of species identifiers in the tier

public record TierDefinition(int index, int levelCap, Set<net.minecraft.resources.ResourceLocation> species) extends Record
Immutable definition of a trainer tier
Since:
1.0.0
  • Constructor Summary

    Constructors
    Constructor
    Description
    TierDefinition(int index, int levelCap, Set<net.minecraft.resources.ResourceLocation> species)
    Canonical constructor ensuring the species set is unmodifiable.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    int
    Returns the value of the index record component.
    int
    Returns the value of the levelCap record component.
    Set<net.minecraft.resources.ResourceLocation>
    Returns the value of the species record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • TierDefinition

      public TierDefinition(int index, int levelCap, Set<net.minecraft.resources.ResourceLocation> species)
      Canonical constructor ensuring the species set is unmodifiable.
      Parameters:
      index - the tier index (1-based)
      levelCap - the level cap for the tier
      species - the list of species identifiers in the tier
  • 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.
    • index

      public int index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component
    • levelCap

      public int levelCap()
      Returns the value of the levelCap record component.
      Returns:
      the value of the levelCap record component
    • species

      public Set<net.minecraft.resources.ResourceLocation> species()
      Returns the value of the species record component.
      Returns:
      the value of the species record component