Package com.winterhavenmc.lodestar.models.destination

Interface ValidDestination

All Superinterfaces:
Destination, com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable
All Known Implementing Classes:
HomeDestination, SpawnDestination, StoredDestination, TeleportDestination
public sealed interface ValidDestination extends Destination permits HomeDestination, SpawnDestination, StoredDestination, TeleportDestination
Record class that Represents a valid destination with accessor methods for destination fields and derived values

  • Field Summary

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

    VALID_DISPLAY_NAME

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    displayName()
     
    default String
    getDisplayName()
    Accessor method to fulfill DisplayNameable interface
    default String
    key()
    Accessor for derived value for destination key field

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

    extractDisplayName

  • Method Details

    • displayName

      String displayName()

    • key

      default String key()
      Accessor for derived value for destination key field
      Returns:
      the value of the key field

    • getDisplayName

      default String getDisplayName()
      Accessor method to fulfill DisplayNameable interface
      Specified by:
      getDisplayName in interface Destination
      Specified by:
      getDisplayName in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable
      Returns:
      the display name of the destination