Package org.apache.sis.util.resources

Class Vocabulary

java.lang.Object
java.util.ResourceBundle
org.apache.sis.util.resources.IndexedResourceBundle
org.apache.sis.util.resources.Vocabulary
All Implemented Interfaces:
Localized
public final class Vocabulary extends IndexedResourceBundle
Locale-dependent resources for single words or short sentences.
Since:
0.3
Version:
1.1
Author:
Martin Desruisseaux (IRD, Geomatys)

  • Method Details

    • getKeyConstants

      protected KeyConstants getKeyConstants()
      Returns the handle for the Keys constants.
      Overrides:
      getKeyConstants in class IndexedResourceBundle
      Returns:
      a handler for the constants declared in the inner Keys class.

    • getResources

      public static Vocabulary getResources(Locale locale) throws MissingResourceException
      Returns resources in the given locale.
      Parameters:
      locale - the locale, or null for the default locale.
      Returns:
      resources in the given locale.
      Throws:
      MissingResourceException - if resources cannot be found.

    • getResources

      public static Vocabulary getResources(Map<?,?> properties) throws MissingResourceException
      Returns resources in the locale specified in the given property map. This convenience method looks for the IndexedResourceBundle.LOCALE_KEY entry. If the given map is null, or contains no entry for the locale key, or the value is not an instance of Locale, then this method fallback on the default locale.
      Parameters:
      properties - the map of properties, or null if none.
      Returns:
      resources in the given locale.
      Throws:
      MissingResourceException - if resources cannot be found.
      Since:
      0.7

    • format

      public static String format(short key) throws MissingResourceException
      Gets a string for the given key from this resource bundle or one of its parents.
      Parameters:
      key - the key for the desired string.
      Returns:
      the string for the given key.
      Throws:
      MissingResourceException - if no object for the given key can be found.

    • formatInternational

      public static org.opengis.util.InternationalString formatInternational(short key)
      Gets an international string for the given key. This method does not check for the key validity. If the key is invalid, then a MissingResourceException may be thrown when a InternationalString.toString(Locale) method is invoked.
      Parameters:
      key - the key for the desired string.
      Returns:
      an international string for the given key.

    • formatInternational

      public static org.opengis.util.InternationalString formatInternational(short key, Object arg)
      Gets an international string for the given key. This method does not check for the key validity. If the key is invalid, then a MissingResourceException may be thrown when a InternationalString.toString(Locale) method is invoked.
      API note: This method is redundant with the one expecting Object..., but avoid the creation of a temporary array. There is no risk of confusion since the two methods delegate their work to the same format method anyway.
      Parameters:
      key - the key for the desired string.
      arg - values to substitute to "{0}".
      Returns:
      an international string for the given key.

    • formatInternational

      public static org.opengis.util.InternationalString formatInternational(short key, Object... args)
      Gets an international string for the given key. This method does not check for the key validity. If the key is invalid, then a MissingResourceException may be thrown when a InternationalString.toString(Locale) method is invoked.
      Parameters:
      key - the key for the desired string.
      args - values to substitute to "{0}", "{1}", etc.
      Returns:
      an international string for the given key.