Package kr.toxicity.hud.api.player

Record Class PointedLocation

java.lang.Object
java.lang.Record
kr.toxicity.hud.api.player.PointedLocation
Record Components:
source - source
name - name
icon - pointer name
location - location
public record PointedLocation(@NotNull PointedLocationSource source, @NotNull String name, @Nullable String icon, @NotNull LocationWrapper location) extends Record
Location with source and name.

  • Constructor Details

    • PointedLocation

      public PointedLocation(@NotNull @NotNull PointedLocationSource source, @NotNull @NotNull String name, @Nullable @Nullable String icon, @NotNull @NotNull LocationWrapper location)
      Creates an instance of a PointedLocation record class.
      Parameters:
      source - the value for the source record component
      name - the value for the name record component
      icon - the value for the icon record component
      location - the value for the location record component

  • Method Details

    • 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

    • deserialize

      @NotNull public static @NotNull PointedLocation deserialize(@NotNull @NotNull YamlObject data)
      Finds location from YAML.
      Parameters:
      data - raw data
      Returns:
      location

    • deserialize

      @NotNull public static @NotNull PointedLocation deserialize(@NotNull @NotNull com.google.gson.JsonObject data)
      Finds location from JSON.
      Parameters:
      data - raw data
      Returns:
      location

    • serialize

      @NotNull public @NotNull Map<String,Object> serialize()
      Serializes to map.
      Returns:
      map

    • 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

    • source

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

    • name

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

    • icon

      @Nullable public @Nullable String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component

    • location

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