Package me.a8kj.config.template.replacement.impl

Record Class PlaceholderProcessor

java.lang.Object
java.lang.Record
me.a8kj.config.template.replacement.impl.PlaceholderProcessor
Record Components:
prefix - the character(s) placed before the key.
suffix - the character(s) placed after the key.
All Implemented Interfaces:
ReplacementProcessor
public record PlaceholderProcessor(String prefix, String suffix) extends Record implements ReplacementProcessor
A highly customizable implementation of ReplacementProcessor that wraps keys with specified prefixes and suffixes. This record-based implementation allows for quick creation of different placeholder styles (e.g., %key%, {key}, ).
Since:
0.1
Author:
a8kj7sea

  • Constructor Details

    • PlaceholderProcessor

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

  • Method Details

    • percent

      public static PlaceholderProcessor percent()
      Creates a processor for percent-style placeholders: %key%.

    • brackets

      public static PlaceholderProcessor brackets()
      Creates a processor for bracket-style placeholders: {key}.

    • chevron

      public static PlaceholderProcessor chevron()
      Creates a processor for chevron-style placeholders: <key>.

    • process

      public String process(String text, Replacement... replacements)
      Replaces all identified placeholders in the text with their corresponding values. The method constructs the target string using prefix + key + suffix and performs a literal string replacement.
      Specified by:
      process in interface ReplacementProcessor
      Parameters:
      text - the template string.
      replacements - the data mappings to apply.
      Returns:
      the processed string, or the original text if no replacements are provided.

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

    • prefix

      public String prefix()
      Returns the value of the prefix record component.
      Returns:
      the value of the prefix record component

    • suffix

      public String suffix()
      Returns the value of the suffix record component.
      Returns:
      the value of the suffix record component