Package net.kyori.adventure.text.minimessage.tag.resolver

Class Formatter

java.lang.Object
net.kyori.adventure.text.minimessage.tag.resolver.Formatter
public final class Formatter extends Object
Tag resolvers producing tags that insert formatted values.

These are effectively placeholders.

Since:
4.11.0

  • Method Details

    • number

      @NotNull public static @NotNull TagResolver number(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull Number number)
      Creates a replacement that inserts a number as a component. The component will be formatted by the provided DecimalFormat.

      This tag accepts a locale, a format pattern, both or nothing as arguments. The locale has to be provided as first argument.

      Refer to Locale for usable locale tags. Refer to DecimalFormat for usable patterns.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      number - the number
      Returns:
      the placeholder
      Since:
      4.11.0

    • date

      @NotNull public static @NotNull TagResolver date(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull TemporalAccessor time)
      Creates a replacement that inserts a date or a time as a component. The component will be formatted by the provided Date Format.

      This tag expects a format as attribute. Refer to DateTimeFormatter for usable patterns.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      time - the time
      Returns:
      the placeholder
      Since:
      4.11.0

    • choice

      @NotNull public static @NotNull TagResolver choice(@TagPattern @NotNull @NotNull String key, Number number)
      Creates a replacement that inserts a choice formatted text. The component will be formatted by the provided ChoiceFormat.

      This tag expectes a format as attribute. Refer to ChoiceFormat for usable patterns.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      number - the number
      Returns:
      the placeholder
      Since:
      4.11.0

    • booleanChoice

      public static TagResolver booleanChoice(@TagPattern @NotNull @NotNull String key, boolean value)
      Creates a choice tag. This will use the first argument when true, otherwise the second argument.

      This tag expects two formats as attributes.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      value - the value
      Returns:
      the placeholder
      Since:
      4.13.0

    • joining

      public static TagResolver joining(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull Iterable<? extends ComponentLike> components)
      Creates a replacement that inserts a list of components. These components are joined together by Component.join(JoinConfiguration.Builder, ComponentLike...).

      This tag has three optional arguments; a separator, a last separator, and a last separator if serial. Each argument must be provided in order, with all preceding arguments present. The exact use of these three separators is documented in JoinConfiguration.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      components - the components to join
      Returns:
      the placeholder
      Since:
      4.18.0
      See Also:

    • joining

      public static TagResolver joining(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull ComponentLike @NotNull ... components)
      Creates a replacement that inserts a list of components. These components are joined together by Component.join(JoinConfiguration.Builder, ComponentLike...).

      This tag has three optional arguments; a separator, a last separator, and a last separator if serial. Each argument must be provided in order, with all preceding arguments present. The exact use of these three separators is documented in JoinConfiguration.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      components - the components to join
      Returns:
      the placeholder
      Since:
      4.18.0
      See Also: