Package com.winterhavenmc.lodestar.models.location

Record Class ValidLocation

java.lang.Object
java.lang.Record
com.winterhavenmc.lodestar.models.location.ValidLocation
All Implemented Interfaces:
com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable, ConfirmedLocation
public record ValidLocation(String worldName, UUID worldUid, double x, double y, double z, float yaw, float pitch) extends Record implements ConfirmedLocation, com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable
Represents a valid Bukkit Location, using only immutable fields.

Note: While this type represents a Location that was valid when created, it can offer no guarantee that the location's world has not been subsequently unloaded or deleted.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable

    com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidLocation(String worldName, UUID worldUid, double x, double y, double z, float yaw, float pitch)
    Creates an instance of a ValidLocation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    org.bukkit.Location
    getLocation()
    Return a Bukkit Location represented by this ConfirmedLocation.
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    pitch()
    Returns the value of the pitch record component.
    final String
    toString()
    Returns a string representation of this record class.
    org.bukkit.World
    world()
    Return the world for this location.
    String
    worldName()
    Returns the value of the worldName record component.
    UUID
    worldUid()
    Returns the value of the worldUid record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    float
    yaw()
    Returns the value of the yaw record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable

    extractLocation

  • Constructor Details

    • ValidLocation

      public ValidLocation(String worldName, UUID worldUid, double x, double y, double z, float yaw, float pitch)
      Creates an instance of a ValidLocation record class.
      Parameters:
      worldName - the value for the worldName record component
      worldUid - the value for the worldUid record component
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      yaw - the value for the yaw record component
      pitch - the value for the pitch record component

  • Method Details

    • world

      public org.bukkit.World world()
      Return the world for this location.
      Returns:
      instance of a Bukkit World, or null if the location's world has been deleted after creation of this instance.

    • getLocation

      public org.bukkit.Location getLocation()
      Return a Bukkit Location represented by this ConfirmedLocation.
      Specified by:
      getLocation in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable
      Returns:
      instance of a Bukkit Location

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

    • worldName

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

    • worldUid

      public UUID worldUid()
      Returns the value of the worldUid record component.
      Returns:
      the value of the worldUid record component

    • x

      public double x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • z

      public double z()
      Returns the value of the z record component.
      Returns:
      the value of the z record component

    • yaw

      public float yaw()
      Returns the value of the yaw record component.
      Returns:
      the value of the yaw record component

    • pitch

      public float pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component