Record Class ChatTypeDefinition

java.lang.Object
java.lang.Record
fr.fidorial.chat.ChatTypeDefinition
Record Components:
key - the namespaced identifier of the chat type
chat - how the message is shown in the chat log
narration - how the message is read out for narration/accessibility
All Implemented Interfaces:
ChatType, ChatType, Keyed
public record ChatTypeDefinition(Key key, ChatTypeDecoration chat, ChatTypeDecoration narration) extends Record implements ChatType, ChatType
A complete chat type definition, ready to be sent to clients.
Since:
0.1.0

  • Constructor Details

    • ChatTypeDefinition

      public ChatTypeDefinition(Key key, ChatTypeDecoration chat, ChatTypeDecoration narration)
      Creates an instance of a ChatTypeDefinition record class.
      Parameters:
      key - the value for the key record component
      chat - the value for the chat record component
      narration - the value for the narration record component

  • Method Details

    • builder

      @Contract(value="_ -> new", pure=true) public static ChatTypeBuilder builder(Key key)
      Returns a new builder for the chat type identified by key.
      Parameters:
      key - the namespaced identifier of the chat type
      Returns:
      a new builder for the chat type identified by key

    • builder

      @Contract(value="_ -> new", pure=true) public static ChatTypeBuilder builder(ChatTypeDefinition definition)
      Returns a new builder pre-filled with the values of definition.
      Parameters:
      definition - the definition to copy
      Returns:
      a new builder pre-filled with the values of definition

    • typedKey

      @Contract(value="-> new", pure=true) public TypedKey<ChatType> typedKey()
      Returns this chat type's key, typed against the minecraft:chat_type registry.
      Returns:
      this chat type's key, typed against the minecraft:chat_type registry

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

    • key

      public Key key()
      Returns the value of the key record component.
      Specified by:
      key in interface ChatType
      Specified by:
      key in interface Keyed
      Returns:
      the value of the key record component

    • chat

      public ChatTypeDecoration chat()
      Returns the value of the chat record component.
      Returns:
      the value of the chat record component

    • narration

      public ChatTypeDecoration narration()
      Returns the value of the narration record component.
      Returns:
      the value of the narration record component