org.ops4j.util.i18n
Class Resources

java.lang.Object
  org.ops4j.util.i18n.Resources

public final class Resources
extends java.lang.Object

A class to simplify extracting localized strings, icons and other common resources from a ResourceBundle.

Reworked to mirror behaviour of StringManager from Tomcat (format() to getString()).

Author:

Open Participation Software for Java

Constructor Summary

Resources(java.lang.String baseName)
Constructor that builds a manager in default locale.

Resources(java.lang.String baseName, java.lang.ClassLoader classLoader)
Constructor that builds a manager in default locale using specified ClassLoader.

Resources(java.lang.String baseName, java.util.Locale locale)
Constructor that builds a manager in specified locale.

Resources(java.lang.String baseName, java.util.Locale locale, java.lang.ClassLoader classLoader)
Constructor that builds a manager in specified locale.

Method Summary

java.lang.String	format(java.lang.String key, java.lang.Object[] args) Retrieve a string from resource bundle and format it with specified args.
boolean	getBoolean(java.lang.String key) Retrieve a boolean from bundle.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Retrieve a boolean from bundle.
java.util.ResourceBundle	getBundle() Retrieve underlying ResourceBundle.
byte	getByte(java.lang.String key) Retrieve a byte from bundle.
byte	getByte(java.lang.String key, byte defaultValue) Retrieve a byte from bundle.
char	getChar(java.lang.String key) Retrieve a char from bundle.
char	getChar(java.lang.String key, char defaultValue) Retrieve a char from bundle.
java.util.Date	getDate(java.lang.String key) Retrieve a date from bundle.
java.util.Date	getDate(java.lang.String key, java.util.Date defaultValue) Retrieve a date from bundle.
java.util.Date	getDateTime(java.lang.String key) Retrieve a date + time from bundle.
java.util.Date	getDateTime(java.lang.String key, java.util.Date defaultValue) Retrieve a time from bundle.
double	getDouble(java.lang.String key) Retrieve a double from bundle.
double	getDouble(java.lang.String key, double defaultValue) Retrieve a double from bundle.
float	getFloat(java.lang.String key) Retrieve a float from bundle.
float	getFloat(java.lang.String key, float defaultValue) Retrieve a float from bundle.
int	getInteger(java.lang.String key) Retrieve a integer from bundle.
int	getInteger(java.lang.String key, int defaultValue) Retrieve a integer from bundle.
long	getLong(java.lang.String key) Retrieve a long from bundle.
long	getLong(java.lang.String key, long defaultValue) Retrieve a long from bundle.
short	getShort(java.lang.String key) Retrieve a short from bundle.
short	getShort(java.lang.String key, short defaultValue) Retrieve a short from bundle.
java.lang.String	getString(java.lang.String key) Retrieve a raw string from bundle.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1) Retrieve a string from resource bundle and format it with specified args.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2) Retrieve a string from resource bundle and format it with specified args.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Retrieve a string from resource bundle and format it with specified args.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Retrieve a string from resource bundle and format it with specified args.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Retrieve a string from resource bundle and format it with specified args.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6) Retrieve a string from resource bundle and format it with specified args.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7) Retrieve a string from resource bundle and format it with specified args.
java.util.Date	getTime(java.lang.String key) Retrieve a time from bundle.
java.util.Date	getTime(java.lang.String key, java.util.Date defaultValue) Retrieve a time from bundle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Resources

public Resources(java.lang.String baseName)

Constructor that builds a manager in default locale.

Parameters:

baseName - the base name of ResourceBundle

Resources

public Resources(java.lang.String baseName,
                 java.lang.ClassLoader classLoader)

Constructor that builds a manager in default locale using specified ClassLoader.

Parameters:

baseName - the base name of ResourceBundle

classLoader - the classLoader to load ResourceBundle from

Resources

public Resources(java.lang.String baseName,
                 java.util.Locale locale)

Constructor that builds a manager in specified locale.

Parameters:

baseName - the base name of ResourceBundle

locale - the Locale for resource bundle

Resources

public Resources(java.lang.String baseName,
                 java.util.Locale locale,
                 java.lang.ClassLoader classLoader)

Constructor that builds a manager in specified locale.

Parameters:

baseName - the base name of ResourceBundle

locale - the Locale for resource bundle

classLoader - the classLoader to load ResourceBundle from

Method Detail

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)
                   throws java.util.MissingResourceException

Retrieve a boolean from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource boolean

Throws:

java.util.MissingResourceException - if the requested key is unknown

getBoolean

public boolean getBoolean(java.lang.String key)
                   throws java.util.MissingResourceException

Retrieve a boolean from bundle.

Parameters:

key - the key of resource

Returns:

the resource boolean

Throws:

java.util.MissingResourceException - if the requested key is unknown

getByte

public byte getByte(java.lang.String key,
                    byte defaultValue)
             throws java.util.MissingResourceException

Retrieve a byte from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource byte

Throws:

java.util.MissingResourceException - if the requested key is unknown

getByte

public byte getByte(java.lang.String key)
             throws java.util.MissingResourceException

Retrieve a byte from bundle.

Parameters:

key - the key of resource

Returns:

the resource byte

Throws:

java.util.MissingResourceException - if the requested key is unknown

getChar

public char getChar(java.lang.String key,
                    char defaultValue)
             throws java.util.MissingResourceException

Retrieve a char from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource char

Throws:

java.util.MissingResourceException - if the requested key is unknown

getChar

public char getChar(java.lang.String key)
             throws java.util.MissingResourceException

Retrieve a char from bundle.

Parameters:

key - the key of resource

Returns:

the resource char

Throws:

java.util.MissingResourceException - if the requested key is unknown

getShort

public short getShort(java.lang.String key,
                      short defaultValue)
               throws java.util.MissingResourceException

Retrieve a short from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource short

Throws:

java.util.MissingResourceException - if the requested key is unknown

getShort

public short getShort(java.lang.String key)
               throws java.util.MissingResourceException

Retrieve a short from bundle.

Parameters:

key - the key of resource

Returns:

the resource short

Throws:

java.util.MissingResourceException - if the requested key is unknown

getInteger

public int getInteger(java.lang.String key,
                      int defaultValue)
               throws java.util.MissingResourceException

Retrieve a integer from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource integer

Throws:

java.util.MissingResourceException - if the requested key is unknown

getInteger

public int getInteger(java.lang.String key)
               throws java.util.MissingResourceException

Retrieve a integer from bundle.

Parameters:

key - the key of resource

Returns:

the resource integer

Throws:

java.util.MissingResourceException - if the requested key is unknown

getLong

public long getLong(java.lang.String key,
                    long defaultValue)
             throws java.util.MissingResourceException

Retrieve a long from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource long

Throws:

java.util.MissingResourceException - if the requested key is unknown

getLong

public long getLong(java.lang.String key)
             throws java.util.MissingResourceException

Retrieve a long from bundle.

Parameters:

key - the key of resource

Returns:

the resource long

Throws:

java.util.MissingResourceException - if the requested key is unknown

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)
               throws java.util.MissingResourceException

Retrieve a float from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource float

Throws:

java.util.MissingResourceException - if the requested key is unknown

getFloat

public float getFloat(java.lang.String key)
               throws java.util.MissingResourceException

Retrieve a float from bundle.

Parameters:

key - the key of resource

Returns:

the resource float

Throws:

java.util.MissingResourceException - if the requested key is unknown

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)
                 throws java.util.MissingResourceException

Retrieve a double from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource double

Throws:

java.util.MissingResourceException - if the requested key is unknown

getDouble

public double getDouble(java.lang.String key)
                 throws java.util.MissingResourceException

Retrieve a double from bundle.

Parameters:

key - the key of resource

Returns:

the resource double

Throws:

java.util.MissingResourceException - if the requested key is unknown

getDate

public java.util.Date getDate(java.lang.String key,
                              java.util.Date defaultValue)
                       throws java.util.MissingResourceException

Retrieve a date from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource date

Throws:

java.util.MissingResourceException - if the requested key is unknown

getDate

public java.util.Date getDate(java.lang.String key)
                       throws java.util.MissingResourceException

Retrieve a date from bundle.

Parameters:

key - the key of resource

Returns:

the resource date

Throws:

java.util.MissingResourceException - if the requested key is unknown

getTime

public java.util.Date getTime(java.lang.String key,
                              java.util.Date defaultValue)
                       throws java.util.MissingResourceException

Retrieve a time from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource time

Throws:

java.util.MissingResourceException - if the requested key is unknown

getTime

public java.util.Date getTime(java.lang.String key)
                       throws java.util.MissingResourceException

Retrieve a time from bundle.

Parameters:

key - the key of resource

Returns:

the resource time

Throws:

java.util.MissingResourceException - if the requested key is unknown

getDateTime

public java.util.Date getDateTime(java.lang.String key,
                                  java.util.Date defaultValue)
                           throws java.util.MissingResourceException

Retrieve a time from bundle.

Parameters:

key - the key of resource

defaultValue - the default value if key is missing

Returns:

the resource time

Throws:

java.util.MissingResourceException - if the requested key is unknown

getDateTime

public java.util.Date getDateTime(java.lang.String key)
                           throws java.util.MissingResourceException

Retrieve a date + time from bundle.

Parameters:

key - the key of resource

Returns:

the resource date + time

Throws:

java.util.MissingResourceException - if the requested key is unknown

getString

public java.lang.String getString(java.lang.String key)
                           throws java.util.MissingResourceException

Retrieve a raw string from bundle.

Parameters:

key - the key of resource

Returns:

the resource string

Throws:

java.util.MissingResourceException - if the requested key is unknown

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

Returns:

the formatted string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

arg2 - an arg

Returns:

the formatted string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

arg2 - an arg

arg3 - an arg

Returns:

the formatted string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3,
                                  java.lang.Object arg4)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

arg2 - an arg

arg3 - an arg

arg4 - an arg

Returns:

the formatted string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3,
                                  java.lang.Object arg4,
                                  java.lang.Object arg5)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

arg2 - an arg

arg3 - an arg

arg4 - an arg

arg5 - an arg

Returns:

the formatted string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3,
                                  java.lang.Object arg4,
                                  java.lang.Object arg5,
                                  java.lang.Object arg6)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

arg2 - an arg

arg3 - an arg

arg4 - an arg

arg5 - an arg

arg6 - an arg

Returns:

the formatted string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3,
                                  java.lang.Object arg4,
                                  java.lang.Object arg5,
                                  java.lang.Object arg6,
                                  java.lang.Object arg7)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

arg1 - an arg

arg2 - an arg

arg3 - an arg

arg4 - an arg

arg5 - an arg

arg6 - an arg

arg7 - an arg

Returns:

the formatted string

format

public java.lang.String format(java.lang.String key,
                               java.lang.Object[] args)

Retrieve a string from resource bundle and format it with specified args.

Parameters:

key - the key for resource

args - an array of args

Returns:

the formatted string

getBundle

public java.util.ResourceBundle getBundle()
                                   throws java.util.MissingResourceException

Retrieve underlying ResourceBundle. If bundle has not been loaded it will be loaded by this method. Access is given in case other resources need to be extracted that this Manager does not provide simplified access to.

Returns:

the ResourceBundle

Throws:

java.util.MissingResourceException - if an error occurs