Package net.kyori.moonshine.message

Record Class StringMessageRenderer<R,I,O,F>

java.lang.Object
java.lang.Record
net.kyori.moonshine.message.StringMessageRenderer<R,I,O,F>
All Implemented Interfaces:
net.kyori.moonshine.message.IMessageRenderer<R,I,O,F>
public record StringMessageRenderer<R,I,O,F>(String prefix, String suffix, Function<I,String> intermediateToStringConverter, Function<String,O> stringToOutputConverter, Function<F,String> placeholderValueToStringConverter) extends Record implements net.kyori.moonshine.message.IMessageRenderer<R,I,O,F>
A standard formatter for strings using String.replace(CharSequence, CharSequence) with "${prefix}${value}${suffix}" where value is converted using placeholderValueToStringConverter.

Most people will want a more advanced formatter for Discord messages/embeds, Minecraft component messages, etc.

  • Constructor Details

    • StringMessageRenderer

      public StringMessageRenderer(String prefix, String suffix, Function<I,String> intermediateToStringConverter, Function<String,O> stringToOutputConverter, Function<F,String> placeholderValueToStringConverter)
      Creates an instance of a StringMessageRenderer record class.
      Parameters:
      prefix - the value for the prefix record component
      suffix - the value for the suffix record component
      intermediateToStringConverter - the value for the intermediateToStringConverter record component
      stringToOutputConverter - the value for the stringToOutputConverter record component
      placeholderValueToStringConverter - the value for the placeholderValueToStringConverter record component

  • Method Details

    • render

      public O render(R receiver, I intermediateMessage, Map<String,? extends F> resolvedPlaceholders, Method method, Type owner)
      Specified by:
      render in interface net.kyori.moonshine.message.IMessageRenderer<R,I,O,F>

    • 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

    • intermediateToStringConverter

      public Function<I,String> intermediateToStringConverter()
      Returns the value of the intermediateToStringConverter record component.
      Returns:
      the value of the intermediateToStringConverter record component

    • stringToOutputConverter

      public Function<String,O> stringToOutputConverter()
      Returns the value of the stringToOutputConverter record component.
      Returns:
      the value of the stringToOutputConverter record component

    • placeholderValueToStringConverter

      public Function<F,String> placeholderValueToStringConverter()
      Returns the value of the placeholderValueToStringConverter record component.
      Returns:
      the value of the placeholderValueToStringConverter record component