xdev.util.res

Class ResourceUtils

java.lang.Object

xdev.util.res.ResourceUtils

public final class ResourceUtils
extends Object

The ResourceUtils class provides utility methods for resource handling.

Since:

2.0

Author:

XDEV Software

Method Summary

Modifier and Type	Method and Description
static InputStream	getResource(String path)
static String	getResourceString(String key) Returns the localized String for the given key.
static String	getResourceString(String key, Locale locale) Returns the localized String for the given key and locale.
static String	getResourceString(String key, Locale locale, Object requestor) Returns the localized String for the given key and locale.
static String	getResourceString(String key, Object requestor) Returns the localized String for the given key.
static String	localizeString(String str, Locale locale, Object requestor) Returns the localized version of the given String str.
static String	localizeString(String str, Object requestor) Returns the localized version of the given String str.
static char	optLocalizeChar(String str, Object requestor) Returns the localized version of the given String str as char if the result is a 1-length String, '\0' otherwise.
static String	optLocalizeString(String str, Object requestor) Returns the localized version of the given String str.
static void	setHandler(ResourceHandler resourceHandler) Sets the ResourceHandler.

Methods inherited from class java.lang.Object

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

Method Detail

setHandler

public static void setHandler(ResourceHandler resourceHandler)
                       throws NullPointerException

Sets the ResourceHandler.

Parameters:

resourceHandler - ResourceHandler to be set.

Throws:

NullPointerException - if resourceHandler is null

getResourceString

public static String getResourceString(String key)
                                throws MissingResourceException

Returns the localized String for the given key.

The current set Locale is used to lookup the requested String

Parameters:

key - to get localized String for.

Returns:

the localized String for the given key.

Throws:

MissingResourceException - if no String could be found in the current set Locale for the given key.

See Also:

Locale

getResourceString

public static String getResourceString(String key,
                                       Object requestor)
                                throws MissingResourceException

Returns the localized String for the given key.

The current set Locale is used to lookup the requested String

Parameters:

key - to get localized String for.

requestor - object that requests the resource String. The requestor may be crucial how the strategy is looking for the resource. If requestor is null only the default resource bundle is searched through.

Returns:

the localized String for the given key.

Throws:

MissingResourceException - if no String could be found in the current set Locale for the given key.

See Also:

Locale

getResourceString

public static String getResourceString(String key,
                                       Locale locale)
                                throws MissingResourceException

Returns the localized String for the given key and locale.

Parameters:

key - to get localized String for.

locale - to lookup the String for.

Returns:

the localized String for the given key.

Throws:

MissingResourceException - if no String could be found in the current set Locale for the given key.

See Also:

Locale

getResourceString

public static String getResourceString(String key,
                                       Locale locale,
                                       Object requestor)
                                throws MissingResourceException

Returns the localized String for the given key and locale.

Parameters:

key - to get localized String for.

locale - to lookup the String for.

requestor - object that requests the resource String. The requestor may be crucial how the strategy is looking for the resource. If requestor is null only the default resource bundle is searched through.

Returns:

the localized String for the given key.

Throws:

MissingResourceException - if no String could be found in the current set Locale for the given key.

See Also:

Locale

optLocalizeString

public static String optLocalizeString(String str,
                                       Object requestor)

Returns the localized version of the given String str. Only parts of the String fitting the pattern {$myKey} will be localized. myKey represents the key for a localized String in the chosen Locale.

The current set Locale is used to lookup the requested String.

Hint: The MissingResourceException is suppressed by the method. The stack trace of the MissingResourceException will be reported to the Application's logger.

Parameters:

str - to localize

requestor - object that requests the resource String. The requestor may be crucial how the strategy is looking for the resource. If requestor is null only the default resource bundle is searched through.

Returns:

the localized String for the given str.

See Also:

Locale

optLocalizeChar

public static char optLocalizeChar(String str,
                                   Object requestor)

Returns the localized version of the given String str as char if the result is a 1-length String, '\0' otherwise. Only parts of the String fitting the pattern {$myKey} will be localized. myKey represents the key for a localized String in the chosen Locale.

The current set Locale is used to lookup the requested String.

Hint: The MissingResourceException is suppressed by the method. The stack trace of the MissingResourceException will be reported to the Application's logger.

Parameters:

str - to localize

requestor - object that requests the resource String. The requestor may be crucial how the strategy is looking for the resource. If requestor is null only the default resource bundle is searched through.

Returns:

the localized char for the given str or '\0'.

See Also:

Locale

localizeString

public static String localizeString(String str,
                                    Object requestor)
                             throws MissingResourceException

Returns the localized version of the given String str. Only parts of the String fitting the pattern {$myKey} will be localized. myKey represents the key for a localized String in the chosen Locale.

The current set Locale is used to lookup the requested String.

Parameters:

str - to localize

requestor - object that requests the resource String. The requestor may be crucial how the strategy is looking for the resource. If requestor is null only the default resource bundle is searched through.

Returns:

the localized String for the given key.

Throws:

MissingResourceException - if no String could be found in the current set Locale for the given key.

See Also:

Locale

localizeString

public static String localizeString(String str,
                                    Locale locale,
                                    Object requestor)
                             throws MissingResourceException

Returns the localized version of the given String str. Only parts of the String fitting the pattern {$myKey} will be localized. myKey represents the key for a localized String in the chosen Locale.

Parameters:

str - to localize

locale - to lookup the String for.

requestor - object that requests the resource String. The requestor may be crucial how the strategy is looking for the resource. If requestor is null only the default resource bundle is searched through.

Returns:

the localized String for the given key.

Throws:

MissingResourceException - if no String could be found in the current set Locale for the given key.

See Also:

Locale

getResource

public static InputStream getResource(String path)
                               throws IOException

Throws:

IOException