Package one.tranic.t.base.message

Record Class MessageFormat

java.lang.Object
java.lang.Record
one.tranic.t.base.message.MessageFormat
Record Components:
key - the unique identifier for the message
value - the Component value representing the message content
public record MessageFormat(String key, net.kyori.adventure.text.Component value) extends Record
Record representing a formatted message with a key and a value.

The MessageFormat record is used to pair a unique key with a Component value. This is helpful in scenarios where messages or texts need to be associated with localization keys or identifiers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MessageFormat(String key, net.kyori.adventure.text.Component value)
    Creates an instance of a MessageFormat record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    key()
    Returns the value of the key record component.
    final String
    toString()
    Returns a string representation of this record class.
    net.kyori.adventure.text.Component
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MessageFormat

      public MessageFormat(String key, net.kyori.adventure.text.Component value)
      Creates an instance of a MessageFormat record class.
      Parameters:
      key - the value for the key record component
      value - the value for the value record component

  • Method Details

    • 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 String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • value

      public net.kyori.adventure.text.Component value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component