Package com.winterhavenmc.lodestar.models.destination

Record Class SpawnDestination

java.lang.Object
java.lang.Record
com.winterhavenmc.lodestar.models.destination.SpawnDestination
All Implemented Interfaces:
com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable, Destination, ValidDestination
public record SpawnDestination(String displayName) extends Record implements ValidDestination
Record class that represents a Spawn destination

  • Field Summary

    Fields inherited from interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable

    VALID_DISPLAY_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpawnDestination(String displayName)
    Creates an instance of a SpawnDestination record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    displayName()
    Returns the value of the displayName record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static Destination
    of(String displayName)
     
    @NotNull String
    toString()
    Returns a string representation of this record class.

    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.displayname.DisplayNameable

    extractDisplayName

    Methods inherited from interface com.winterhavenmc.lodestar.models.destination.ValidDestination

    getDisplayName, key

  • Constructor Details

    • SpawnDestination

      public SpawnDestination(String displayName)
      Creates an instance of a SpawnDestination record class.
      Parameters:
      displayName - the value for the displayName record component

  • Method Details

    • of

      public static Destination of(String displayName)

    • 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

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

    • displayName

      public String displayName()
      Returns the value of the displayName record component.
      Specified by:
      displayName in interface ValidDestination
      Returns:
      the value of the displayName record component