org.geotools.util

Class IndexedResourceBundle

Object

ResourceBundle

IndexedResourceBundle

Direct Known Subclasses:

Descriptions, Errors, Errors, Logging, Loggings, Vocabulary, Vocabulary

public class IndexedResourceBundle
extends ResourceBundle

ResourceBundle implementation using integers instead of strings for resource keys. Because it doesn't use strings, this implementation avoids adding all those string constants to .class files and runtime images. Developers still have meaningful labels in their code (e.g. DIMENSION_MISMATCH) through a set of constants defined in interfaces. This approach furthermore gives the benefit of compile-time safety. Because integer constants are inlined right into class files at compile time, the declarative interface is never loaded at run time. This class also provides facilities for string formatting using MessageFormat.

Since:

2.4

Author:

Martin Desruisseaux (IRD)

Nested Class Summary

Nested classes/interfaces inherited from class ResourceBundle

ResourceBundle.Control

Field Summary

Fields inherited from class ResourceBundle

parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexedResourceBundle() Constructs a new resource bundle.
protected	IndexedResourceBundle(String filename) Constructs a new resource bundle.

Method Summary

Modifier and Type	Method and Description
static String	format(LogRecord record) Localize and format the message string from a log record.
Enumeration<String>	getKeys() Returns an enumeration of the keys.
String	getLabel(int key) Gets a string for the given key and appends ": " to it.
LogRecord	getLogRecord(Level level, int key) Gets a localized log record.
LogRecord	getLogRecord(Level level, int key, Object arg0) Gets a localized log record.
LogRecord	getLogRecord(Level level, int key, Object arg0, Object arg1) Gets a localized log record.
LogRecord	getLogRecord(Level level, int key, Object arg0, Object arg1, Object arg2) Gets a localized log record.
LogRecord	getLogRecord(Level level, int key, Object arg0, Object arg1, Object arg2, Object arg3) Gets a localized log record.
String	getMenuLabel(int key) Gets a string for the given key and appends "..." to it.
String	getString(int key) Gets a string for the given key from this resource bundle or one of its parents.
String	getString(int key, Object arg0) Gets a string for the given key and formats it with the specified argument.
String	getString(int key, Object arg0, Object arg1) Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.
String	getString(int key, Object arg0, Object arg1, Object arg2) Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.
String	getString(int key, Object arg0, Object arg1, Object arg2, Object arg3) Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.
String	getString(int key, Object arg0, Object arg1, Object arg2, Object arg3, Object arg4) Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.
protected Object	handleGetObject(String key) Gets an object for the given key from this resource bundle.
void	list(Writer out) Lists resources to the specified stream.
String	toString() Returns a string representation of this object.

Methods inherited from class ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, handleKeySet, keySet, setParent

Methods inherited from class Object

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

Constructor Detail

IndexedResourceBundle

protected IndexedResourceBundle()

Constructs a new resource bundle. The resource filename will be inferred from the fully qualified classname of this IndexedResourceBundle subclass.

IndexedResourceBundle

protected IndexedResourceBundle(String filename)

Constructs a new resource bundle.

Parameters:

filename - The resource name containing resources. It may be a filename or an entry in a JAR file.

Method Detail

list

public final void list(Writer out)
                throws IOException

Lists resources to the specified stream. If a resource has more than one line, only the first line will be written. This method is used mostly for debugging purposes.

Parameters:

out - The destination stream.

Throws:

IOException - if an output operation failed.

getKeys

public final Enumeration<String> getKeys()

Returns an enumeration of the keys.

Specified by:

getKeys in class ResourceBundle

handleGetObject

protected final Object handleGetObject(String key)

Gets an object for the given key from this resource bundle. Returns null if this resource bundle does not contain an object for the given key.

Specified by:

handleGetObject in class ResourceBundle

Parameters:

key - the key for the desired object

Returns:

the object for the given key, or null

Throws:

NullPointerException - if key is null

getMenuLabel

public final String getMenuLabel(int key)
                          throws MissingResourceException

Gets a string for the given key and appends "..." to it. This method is typically used for creating menu items.

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.

getLabel

public final String getLabel(int key)
                      throws MissingResourceException

Gets a string for the given key and appends ": " to it. This method is typically used for creating labels.

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.

getString

public final String getString(int 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.

getString

public final String getString(int key,
                              Object arg0)
                       throws MissingResourceException

Gets a string for the given key and formats it with the specified argument. The message is formatted using MessageFormat. Calling this method is approximately equivalent to calling:

   String pattern = getString(key);
   Format f = new MessageFormat(pattern);
   return f.format(arg0);
 

If arg0 is not already an array, it will be placed into an array of length 1. Using MessageFormat, all occurrences of "{0}", "{1}", "{2}" in the resource string will be replaced by arg0[0], arg0[1], arg0[2], etc.

Parameters:

key - The key for the desired string.

arg0 - A single object or an array of objects to be formatted and substituted.

Returns:

The string for the given key.

Throws:

MissingResourceException - If no object for the given key can be found.

See Also:

ResourceBundle.getString(String), getString(int,Object,Object), getString(int,Object,Object,Object), MessageFormat

getString

public final String getString(int key,
                              Object arg0,
                              Object arg1)
                       throws MissingResourceException

Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.

Parameters:

key - The key for the desired string.

arg0 - Value to substitute for "{0}".

arg1 - Value to substitute for "{1}".

Returns:

The formatted string for the given key.

Throws:

MissingResourceException - If no object for the given key can be found.

getString

public final String getString(int key,
                              Object arg0,
                              Object arg1,
                              Object arg2)
                       throws MissingResourceException

Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.

Parameters:

key - The key for the desired string.

arg0 - Value to substitute for "{0}".

arg1 - Value to substitute for "{1}".

arg2 - Value to substitute for "{2}".

Returns:

The formatted string for the given key.

Throws:

MissingResourceException - If no object for the given key can be found.

getString

public final String getString(int key,
                              Object arg0,
                              Object arg1,
                              Object arg2,
                              Object arg3)
                       throws MissingResourceException

Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.

Parameters:

key - The key for the desired string.

arg0 - Value to substitute for "{0}".

arg1 - Value to substitute for "{1}".

arg2 - Value to substitute for "{2}".

arg3 - Value to substitute for "{3}".

Returns:

The formatted string for the given key.

Throws:

MissingResourceException - If no object for the given key can be found.

getString

public final String getString(int key,
                              Object arg0,
                              Object arg1,
                              Object arg2,
                              Object arg3,
                              Object arg4)
                       throws MissingResourceException

Gets a string for the given key and replaces all occurrences of "{0}", "{1}", with values of arg0, arg1, etc.

Parameters:

key - The key for the desired string.

arg0 - Value to substitute for "{0}".

arg1 - Value to substitute for "{1}".

arg2 - Value to substitute for "{2}".

arg3 - Value to substitute for "{3}".

arg4 - Value to substitute for "{4}".

Returns:

The formatted string for the given key.

Throws:

MissingResourceException - If no object for the given key can be found.

getLogRecord

public LogRecord getLogRecord(Level level,
                              int key)

Gets a localized log record.

Parameters:

level - The log record level.

key - The resource key.

Returns:

The log record.

getLogRecord

public LogRecord getLogRecord(Level level,
                              int key,
                              Object arg0)

Gets a localized log record.

Parameters:

level - The log record level.

key - The resource key.

arg0 - The parameter for the log message, or null.

Returns:

The log record.

getLogRecord

public LogRecord getLogRecord(Level level,
                              int key,
                              Object arg0,
                              Object arg1)

Gets a localized log record.

Parameters:

level - The log record level.

key - The resource key.

arg0 - The first parameter.

arg1 - The second parameter.

Returns:

The log record.

getLogRecord

public LogRecord getLogRecord(Level level,
                              int key,
                              Object arg0,
                              Object arg1,
                              Object arg2)

Gets a localized log record.

Parameters:

level - The log record level.

key - The resource key.

arg0 - The first parameter.

arg1 - The second parameter.

arg2 - The third parameter.

Returns:

The log record.

getLogRecord

public LogRecord getLogRecord(Level level,
                              int key,
                              Object arg0,
                              Object arg1,
                              Object arg2,
                              Object arg3)

Gets a localized log record.

Parameters:

level - The log record level.

key - The resource key.

arg0 - The first parameter.

arg1 - The second parameter.

arg2 - The third parameter.

arg3 - The fourth parameter.

Returns:

The log record.

format

public static String format(LogRecord record)

Localize and format the message string from a log record. This method performs a work similar to Formatter.formatMessage(java.util.logging.LogRecord), except that the work will be delegated to getString(int, Object) if the record resource bundle is an instance of IndexedResourceBundle.

Parameters:

record - The log record to format.

Returns:

The formatted message.

toString

public String toString()

Returns a string representation of this object. This method is for debugging purposes only.

Overrides:

toString in class Object