Record Class OffsetChange

java.lang.Object
java.lang.Record
com.jtprince.coordinateoffset.OffsetChange
Record Components:
previousOffsetData - The previous offset data for the player, or null if the player is joining the server.
newOffsetData - The new offset data for the player.

public record OffsetChange(@Nullable OffsetData previousOffsetData, OffsetData newOffsetData) extends Record
Container for all data associated with a player's offset changing.

This record is immutable and represents the final result of an offset change; i.e., it is created after the new offset has already been determined.

  • Constructor Details

    • OffsetChange

      public OffsetChange(@Nullable OffsetData previousOffsetData, OffsetData newOffsetData)
      Creates an instance of a OffsetChange record class.
      Parameters:
      previousOffsetData - the value for the previousOffsetData record component
      newOffsetData - the value for the newOffsetData record component
  • Method Details

    • offsetChanged

      public boolean offsetChanged()
    • 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. 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.
    • previousOffsetData

      public @Nullable OffsetData previousOffsetData()
      Returns the value of the previousOffsetData record component.
      Returns:
      the value of the previousOffsetData record component
    • newOffsetData

      public OffsetData newOffsetData()
      Returns the value of the newOffsetData record component.
      Returns:
      the value of the newOffsetData record component