de.jakop.lotus.domingo.i18n

Class Resources

java.lang.Object

de.jakop.lotus.domingo.i18n.Resources

public final class Resources
extends Object

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

Author:

Kurt Riede

Constructor Summary

Constructors

Constructor and Description
Resources(String theBaseName) Constructor that builds a manager in default locale.
Resources(String theBaseName, ClassLoader theClassLoader) Constructor that builds a manager in default locale using specified ClassLoader.
Resources(String theBaseName, Locale theLocale) Constructor that builds a manager in specified locale.
Resources(String theBaseName, Locale theLocale, ClassLoader theClassLoader) Constructor that builds a manager in specified locale.

Method Summary

Modifier and Type	Method and Description
String	format(String key, Object[] args) Retrieve a string from resource bundle and format it with specified arguments.
boolean	getBoolean(String key) Retrieve a boolean from bundle.
boolean	getBoolean(String key, boolean defaultValue) Retrieve a boolean from bundle.
ResourceBundle	getBundle() Retrieve underlying ResourceBundle.
byte	getByte(String key) Retrieve a byte from bundle.
byte	getByte(String key, byte defaultValue) Retrieve a byte from bundle.
char	getChar(String key) Retrieve a char from bundle.
char	getChar(String key, char defaultValue) Retrieve a char from bundle.
Date	getDate(String key) Retrieve a date from bundle.
Date	getDate(String key, Date defaultValue) Retrieve a date from bundle.
Date	getDateTime(String key) Retrieve a date + time from bundle.
Date	getDateTime(String key, Date defaultValue) Retrieve a time from bundle.
double	getDouble(String key) Retrieve a double from bundle.
double	getDouble(String key, double defaultValue) Retrieve a double from bundle.
float	getFloat(String key) Retrieve a float from bundle.
float	getFloat(String key, float defaultValue) Retrieve a float from bundle.
int	getInteger(String key) Retrieve a integer from bundle.
int	getInteger(String key, int defaultValue) Retrieve a integer from bundle.
long	getLong(String key) Retrieve a long from bundle.
long	getLong(String key, long defaultValue) Retrieve a long from bundle.
short	getShort(String key) Retrieve a short from bundle.
short	getShort(String key, short defaultValue) Retrieve a short from bundle.
String	getString(String key) Retrieve a raw string from bundle.
String	getString(String key, Object arg1) Retrieve a string from resource bundle and format it with specified arguments.
String	getString(String key, Object arg1, Object arg2) Retrieve a string from resource bundle and format it with specified arguments.
String	getString(String key, Object arg1, Object arg2, Object arg3) Retrieve a string from resource bundle and format it with specified arguments.
String	getString(String key, Object arg1, Object arg2, Object arg3, Object arg4) Retrieve a string from resource bundle and format it with specified arguments.
Date	getTime(String key) Retrieve a time from bundle.
Date	getTime(String key, Date defaultValue) Retrieve a time from bundle.
Resources	withFailOnError(boolean failOnError) Whether an exception should be thrown in case of an unknown resource or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Resources

public Resources(String theBaseName)

Constructor that builds a manager in default locale.

Parameters:

theBaseName - the base name of ResourceBundle

Resources

public Resources(String theBaseName,
                 ClassLoader theClassLoader)

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

Parameters:

theBaseName - the base name of ResourceBundle

theClassLoader - the classLoader to load ResourceBundle from

Resources

public Resources(String theBaseName,
                 Locale theLocale)

Constructor that builds a manager in specified locale.

Parameters:

theBaseName - the base name of ResourceBundle

theLocale - the Locale for resource bundle

Resources

public Resources(String theBaseName,
                 Locale theLocale,
                 ClassLoader theClassLoader)

Constructor that builds a manager in specified locale.

Parameters:

theBaseName - the base name of ResourceBundle

theLocale - the Locale for resource bundle

theClassLoader - the classLoader to load ResourceBundle from

Method Detail

withFailOnError

public Resources withFailOnError(boolean failOnError)

Whether an exception should be thrown in case of an unknown resource or not.

Parameters:

failOnError - true if an exception should be thrown in case of an unknown resource, else false

Returns:

the instance itself

getBoolean

public boolean getBoolean(String key,
                          boolean defaultValue)
                   throws 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:

MissingResourceException - if a resource wasn't found

getBoolean

public boolean getBoolean(String key)
                   throws MissingResourceException

Retrieve a boolean from bundle.

Parameters:

key - the key of resource

Returns:

the resource boolean

Throws:

MissingResourceException - if a resource wasn't found

getByte

public byte getByte(String key,
                    byte defaultValue)
             throws 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:

MissingResourceException - if a resource wasn't found

getByte

public byte getByte(String key)
             throws MissingResourceException

Retrieve a byte from bundle.

Parameters:

key - the key of resource

Returns:

the resource byte

Throws:

MissingResourceException - if a resource wasn't found

getChar

public char getChar(String key,
                    char defaultValue)
             throws 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:

MissingResourceException - if a resource wasn't found

getChar

public char getChar(String key)
             throws MissingResourceException

Retrieve a char from bundle.

Parameters:

key - the key of resource

Returns:

the resource char

Throws:

MissingResourceException - if a resource wasn't found

getShort

public short getShort(String key,
                      short defaultValue)
               throws 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:

MissingResourceException - if a resource wasn't found

getShort

public short getShort(String key)
               throws MissingResourceException

Retrieve a short from bundle.

Parameters:

key - the key of resource

Returns:

the resource short

Throws:

MissingResourceException - if a resource wasn't found

getInteger

public int getInteger(String key,
                      int defaultValue)
               throws 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:

MissingResourceException - if a resource wasn't found

getInteger

public int getInteger(String key)
               throws MissingResourceException

Retrieve a integer from bundle.

Parameters:

key - the key of resource

Returns:

the resource integer

Throws:

MissingResourceException - if a resource wasn't found

getLong

public long getLong(String key,
                    long defaultValue)
             throws 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:

MissingResourceException - if a resource wasn't found

getLong

public long getLong(String key)
             throws MissingResourceException

Retrieve a long from bundle.

Parameters:

key - the key of resource

Returns:

the resource long

Throws:

MissingResourceException - if a resource wasn't found

getFloat

public float getFloat(String key,
                      float defaultValue)
               throws 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:

MissingResourceException - if a resource wasn't found

getFloat

public float getFloat(String key)
               throws MissingResourceException

Retrieve a float from bundle.

Parameters:

key - the key of resource

Returns:

the resource float

Throws:

MissingResourceException - if a resource wasn't found

getDouble

public double getDouble(String key,
                        double defaultValue)
                 throws 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:

MissingResourceException - if a resource wasn't found

getDouble

public double getDouble(String key)
                 throws MissingResourceException

Retrieve a double from bundle.

Parameters:

key - the key of resource

Returns:

the resource double

Throws:

MissingResourceException - if a resource wasn't found

getDate

public Date getDate(String key,
                    Date defaultValue)
             throws 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:

MissingResourceException - if a resource wasn't found

getDate

public Date getDate(String key)
             throws MissingResourceException

Retrieve a date from bundle.

Parameters:

key - the key of resource

Returns:

the resource date

Throws:

MissingResourceException - if a resource wasn't found

getTime

public Date getTime(String key,
                    Date defaultValue)
             throws 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:

MissingResourceException - if a resource wasn't found

getTime

public Date getTime(String key)
             throws MissingResourceException

Retrieve a time from bundle.

Parameters:

key - the key of resource

Returns:

the resource time

Throws:

MissingResourceException - if a resource wasn't found

getDateTime

public Date getDateTime(String key,
                        Date defaultValue)
                 throws 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:

MissingResourceException - if a resource wasn't found

getDateTime

public Date getDateTime(String key)
                 throws MissingResourceException

Retrieve a date + time from bundle.

Parameters:

key - the key of resource

Returns:

the resource date + time

Throws:

MissingResourceException - if a resource wasn't found

getString

public String getString(String key)
                 throws MissingResourceException

Retrieve a raw string from bundle.

Parameters:

key - the key of resource

Returns:

the resource string

Throws:

MissingResourceException - if a resource wasn't found

getString

public String getString(String key,
                        Object arg1)

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

Parameters:

key - the key for resource

arg1 - an argument

Returns:

the formatted string

getString

public String getString(String key,
                        Object arg1,
                        Object arg2)

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

Parameters:

key - the key for resource

arg1 - an argument

arg2 - an argument

Returns:

the formatted string

getString

public String getString(String key,
                        Object arg1,
                        Object arg2,
                        Object arg3)

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

Parameters:

key - the key for resource

arg1 - an argument

arg2 - an argument

arg3 - an argument

Returns:

the formatted string

getString

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

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

Parameters:

key - the key for resource

arg1 - an argument

arg2 - an argument

arg3 - an argument

arg4 - an argument

Returns:

the formatted string

format

public String format(String key,
                     Object[] args)
              throws MissingResourceException

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

Parameters:

key - the key for resource

args - an array of arguments

Returns:

the formatted string

Throws:

MissingResourceException - if withFailOnError(boolean) is true and the requested resource wasn't found

See Also:

withFailOnError(boolean)

getBundle

public ResourceBundle getBundle()
                         throws 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:

MissingResourceException - if an error occurs