Package de.aristaflow.adept2.util.i18n

Class SubMessages

java.lang.Object
de.aristaflow.adept2.util.i18n.SubMessages
All Implemented Interfaces:
Messages, Iterable<String>
public class SubMessages extends Object implements Messages
Messages class wrapping another Messages and prepending all requested keys with the same prefix. This allows for sub messages, i. e. several messages that are similar but with different content. A generic class can then be used in different context with different messages but simply use the very same message key independent from the used context.

  • Method Details

    • adaptKey

      protected String adaptKey(String key)
      Gets the adapted designated key, i. e. the key with the corresponding prefix.
      Parameters:
      key - The key without the prefix which to adapt to this sub messages.
      Returns:
      The adapted designated key, i. e. the key with the corresponding prefix.

    • getLocale

      public Locale getLocale()
      Description copied from interface: Messages
      Gets the intended locale of the messages which is also used for MessageFormat.
      Specified by:
      getLocale in interface Messages
      Returns:
      The intended locale of the messages .

    • getActualLocale

      public Locale getActualLocale()
      Description copied from interface: Messages
      Gets the actual locale of this messages. This may be a fallback of the intended locale.
      Specified by:
      getActualLocale in interface Messages
      Returns:
      The actual locale of the messages .

    • containsKey

      public boolean containsKey(String key)
      Description copied from interface: Messages
      Gets whether this Messages contains the designated key.
      Specified by:
      containsKey in interface Messages
      Parameters:
      key - The key to check whether it exists in this Messages.
      Returns:
      Whether this Messages contains the designated key.

    • getString

      public String getString(String key, Object... args)
      Description copied from interface: Messages
      Gets the string for the designated key formatted using String.format(String, Object...). If the key is not known, the key itself will be returned instead of throwing a MissingResoucreException.
      Specified by:
      getString in interface Messages
      Parameters:
      key - The key of the localised string.
      args - The arguments for String.format(String, Object...). If this is null or an empty array, formatting will be skipped.
      Returns:
      The formatted string message for the designated key.

    • getFormattedString

      public String getFormattedString(String key, Object... args)
      Description copied from interface: Messages
      Gets the string for the designated key formatted using Format.format(Object). If the key is not known, the key itself will be returned instead of throwing a MissingResoucreException.
      Specified by:
      getFormattedString in interface Messages
      Parameters:
      key - The key of the localised string.
      args - The arguments for Format.format(Object).
      Returns:
      The formatted string message for the designated key.

    • iterator

      public Iterator<String> iterator()
      Specified by:
      iterator in interface Iterable<String>