Record Class BoneName

java.lang.Object
java.lang.Record
kr.toxicity.model.api.bone.BoneName
Record Components:
tags - tags
name - name
rawName - original name
public record BoneName(@NotNull @Unmodifiable Set<BoneTag> tags, @NotNull String name, @NotNull String rawName) extends Record
A tagged name of some bone

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.google.gson.JsonDeserializer<BoneName>
    PARSER
    A JSON deserializer for parsing BoneName from a string.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BoneName(@NotNull @Unmodifiable Set<BoneTag> tags, @NotNull String name, @NotNull String rawName)
    Internal constructor for BoneName.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    @NotNull String
    name()
    Returns the value of the name record component.
    static @NotNull BoneName
    of(@NotNull String rawName)
    Creates a new BoneName by parsing the raw name string.
    @NotNull String
    rawName()
    Returns the value of the rawName record component.
    boolean
    tagged(@NotNull BoneTag... tags)
    Checks this name has some tags
    @NotNull @Unmodifiable Set<BoneTag>
    tags()
    Returns the value of the tags record component.
    @NotNull BoneItemMapper
    toItemMapper()
    Gets an item mapper of this bone name.
    @NotNull String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

    • PARSER

      public static final com.google.gson.JsonDeserializer<BoneName> PARSER
      A JSON deserializer for parsing BoneName from a string.
      Since:
      2.0.1

  • Constructor Details

    • BoneName

      @Internal public BoneName(@NotNull @NotNull @Unmodifiable Set<BoneTag> tags, @NotNull @NotNull String name, @NotNull @NotNull String rawName)
      Internal constructor for BoneName.

  • Method Details

    • of

      @NotNull public static @NotNull BoneName of(@NotNull @NotNull String rawName)
      Creates a new BoneName by parsing the raw name string.
      Parameters:
      rawName - the raw string to parse
      Returns:
      a parsed BoneName instance
      Since:
      2.0.1

    • tagged

      public boolean tagged(@NotNull @NotNull BoneTag... tags)
      Checks this name has some tags
      Parameters:
      tags - tags
      Returns:
      any match

    • toItemMapper

      @NotNull public @NotNull BoneItemMapper toItemMapper()
      Gets an item mapper of this bone name.
      Returns:
      item mapper

    • equals

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

    • hashCode

      public 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

    • toString

      @NotNull public @NotNull 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

    • tags

      @NotNull public @NotNull @Unmodifiable Set<BoneTag> tags()
      Returns the value of the tags record component.
      Returns:
      the value of the tags record component

    • name

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

    • rawName

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