Localizable
Date: 2016-04-28

org.apache.xmlgraphics.util.i18n

## Interface Localizable

- All Known Subinterfaces:
    ExtendedLocalizable
  All Known Implementing Classes:
    LocalizableSupport

      public interface Localizable

  This interface must be implemented by the classes which must provide a way to override the default locale.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `formatMessage(java.lang.String key, java.lang.Object[] args)` Creates and returns a localized message, given the key of the message in the resource bundle and the message parameters.
    `java.util.Locale` | `getLocale()` Returns the current locale or null if the locale currently used is the default one.
    `void` | `setLocale(java.util.Locale l)` Provides a way to the user to specify a locale which override the default one.

- - ### Method Detail

    - #### setLocale

          void setLocale(java.util.Locale l)

      Provides a way to the user to specify a locale which override the default one. If null is passed to this method, the used locale becomes the global one.
      Parameters:
        `l` - The locale to set.

    - #### getLocale

          java.util.Locale getLocale()

      Returns the current locale or null if the locale currently used is the default one.

    - #### formatMessage

          java.lang.String formatMessage(java.lang.String key,
                                       java.lang.Object[] args)
                                         throws java.util.MissingResourceException

      Creates and returns a localized message, given the key of the message in the resource bundle and the message parameters. The messages in the resource bundle must have the syntax described in the java.text.MessageFormat class documentation.
      Parameters:
        `key` - The key used to retreive the message from the resource bundle.
        `args` - The objects that compose the message.
      Throws:
        `java.util.MissingResourceException` - if the key is not in the bundle.