Record Class EnumType

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.EnumType
Record Components:
id - the enum type ID
inputTypeId - the input key type identifier
outputTypeId - the output value type identifier
intDefault - the default integer value when a key is not found
stringDefault - the default string value when a key is not found
entryCount - the total number of entries in this enum
entries - the key-value mapping entries
public record EnumType(int id, int inputTypeId, int outputTypeId, int intDefault, String stringDefault, int entryCount, Map<String,Object> entries) extends Record
Enum (key-value mapping) definition from the game cache. Enums map input keys to output values (e.g., skill IDs to skill names).
See Also:

  • Constructor Details

    • EnumType

      public EnumType(int id, int inputTypeId, int outputTypeId, int intDefault, String stringDefault, int entryCount, Map<String,Object> entries)
      Creates an instance of a EnumType record class.
      Parameters:
      id - the value for the id record component
      inputTypeId - the value for the inputTypeId record component
      outputTypeId - the value for the outputTypeId record component
      intDefault - the value for the intDefault record component
      stringDefault - the value for the stringDefault record component
      entryCount - the value for the entryCount record component
      entries - the value for the entries record component

  • 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 the compare method from their corresponding wrapper classes.
      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.

    • id

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

    • inputTypeId

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

    • outputTypeId

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

    • intDefault

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

    • stringDefault

      public String stringDefault()
      Returns the value of the stringDefault record component.
      Returns:
      the value of the stringDefault record component

    • entryCount

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

    • entries

      public Map<String,Object> entries()
      Returns the value of the entries record component.
      Returns:
      the value of the entries record component