Class MiniMessageFormatter

  • All Implemented Interfaces:
    Freezable<MiniMessageFormatter>, java.lang.Cloneable

    public final class MiniMessageFormatter
    extends java.lang.Object
    implements Freezable<MiniMessageFormatter>
    Mini message formatter for a small subset of the ICU MessageFormat syntax. Supports only string substitution and select formatting.
    Since:
    2010-aug-21
    • Constructor Detail

      • MiniMessageFormatter

        public MiniMessageFormatter()
      • MiniMessageFormatter

        public MiniMessageFormatter​(MessagePattern msg)
      • MiniMessageFormatter

        public MiniMessageFormatter​(java.lang.String msg)
    • Method Detail

      • getPatternString

        public java.lang.String getPatternString()
      • hasNamedArguments

        public boolean hasNamedArguments()
      • hasNumberedArguments

        public boolean hasNumberedArguments()
      • format

        public java.lang.Appendable format​(java.lang.Appendable dest,
                                           java.lang.Object... args)
        Formats the parsed message with positional arguments. Supports only string substitution (e.g., {3}) and select format.
        Parameters:
        dest - gets the formatted message appended
        args - positional arguments
        Returns:
        dest
      • format

        public static final java.lang.String format​(java.lang.String msg,
                                                    java.lang.Object... args)
      • format

        public java.lang.Appendable format​(java.lang.Appendable dest,
                                           java.util.Map<java.lang.String,​java.lang.Object> argsMap)
      • format

        public static final java.lang.String format​(java.lang.String msg,
                                                    java.util.Map<java.lang.String,​java.lang.Object> argsMap)
      • format

        private int format​(int msgStart,
                           java.lang.Appendable dest,
                           java.lang.Object[] args,
                           java.util.Map<java.lang.String,​java.lang.Object> argsMap)
      • mapFromNameValuePairs

        public static java.util.Map<java.lang.String,​java.lang.Object> mapFromNameValuePairs​(java.lang.Object[] args)
        Presents an array of (String, Object) pairs as a Map. Only for temporary use for formatting with named arguments.