Package me.a8kj.config.template.replacement

Record Class Replacement

java.lang.Object
java.lang.Record
me.a8kj.config.template.replacement.Replacement
Record Components:
key - the placeholder string (e.g., "player", "amount").
value - the content that will replace the placeholder.
public record Replacement(String key, String value) extends Record
A simple data carrier (Record) representing a placeholder and its replacement value. This is used during text transformation to map specific keys to dynamic content.
Since:
0.1
Author:
a8kj7sea

  • Constructor Details

    • Replacement

      public Replacement(String key, String value)
      Creates an instance of a Replacement record class.
      Parameters:
      key - the value for the key record component
      value - the value for the value record component

  • Method Details

    • of

      public static Replacement of(String key, Object value)
      Creates a replacement from a raw object. The object is converted to a string using String.valueOf(Object).
      Parameters:
      key - the placeholder key.
      value - the object value.
      Returns:
      a new Replacement instance.

    • of

      public static Replacement of(String key, Collection<String> collection)
      Creates a replacement from a collection of strings. The elements are joined together using a newline character (\n). Useful for multi-line replacements like lists or messages.
      Parameters:
      key - the placeholder key.
      collection - the collection of strings to join.
      Returns:
      a new Replacement instance.

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