Class Resources

All Implemented Interfaces:
Localized

public final class Resources extends IndexedResourceBundle
Warning and error messages that are specific to the sis-feature module. Resources in this file should not be used by any other module. For resources shared by all modules in the Apache SIS project, see org.apache.sis.util.resources package.
Since:
0.8
Version:
1.1
  • Constructor Details

    • Resources

      public Resources(URL resources)
      Constructs a new resource bundle loading data from the given UTF file.
      Parameters:
      resources - the path of the binary file containing resources, or null if there are no resources. The resources may be a file or an entry in a JAR file.
  • 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.
    • forLocale

      public static Resources forLocale(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.
    • forProperties

      public static Resources forProperties(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.4
    • 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.
    • format

      public static String format(short key, Object arg0) throws MissingResourceException
      Gets a string for the given key and replaces all occurrence of "{0}" with value of arg0.
      Parameters:
      key - the key for the desired string.
      arg0 - value to substitute to "{0}".
      Returns:
      the formatted string for the given key.
      Throws:
      MissingResourceException - if no object for the given key can be found.
    • format

      public static String format(short key, Object arg0, Object arg1) throws MissingResourceException
      Gets a string for the given key and replaces all occurrence of "{0}", "{1}", with values of arg0, arg1.
      Parameters:
      key - the key for the desired string.
      arg0 - value to substitute to "{0}".
      arg1 - value to substitute to "{1}".
      Returns:
      the formatted string for the given key.
      Throws:
      MissingResourceException - if no object for the given key can be found.
    • format

      public static String format(short key, Object arg0, Object arg1, Object arg2) throws MissingResourceException
      Gets a string for the given key and replaces all occurrence of "{0}", "{1}", with values of arg0, arg1, etc.
      Parameters:
      key - the key for the desired string.
      arg0 - value to substitute to "{0}".
      arg1 - value to substitute to "{1}".
      arg2 - value to substitute to "{2}".
      Returns:
      the formatted string for the given key.
      Throws:
      MissingResourceException - if no object for the given key can be found.
    • format

      public static String format(short key, Object arg0, Object arg1, Object arg2, Object arg3) throws MissingResourceException
      Gets a string for the given key and replaces all occurrence of "{0}", "{1}", with values of arg0, arg1, etc.
      Parameters:
      key - the key for the desired string.
      arg0 - value to substitute to "{0}".
      arg1 - value to substitute to "{1}".
      arg2 - value to substitute to "{2}".
      arg3 - value to substitute to "{3}".
      Returns:
      the formatted 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, 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.