com.google.gwt.i18n.rebind

Class AbstractResource

java.lang.Object

com.google.gwt.i18n.rebind.AbstractResource

Direct Known Subclasses:

AnnotationsResource

public abstract class AbstractResource
extends Object

AbstractResource serves the same purpose as java ResourceBundle/PropertyResourceBundle.

Each Resource belongs to a resource tree, indicated by the path attribute.

AbstractResource uses a Factory pattern rather than a single static method to load itself given an abstract string path.

One advanced feature which should not be used outside the core GWT system is that resources can have more than one parent, for instance pets_en_US could have pets_en as one parent and animals_en_US as another. The alternative parents have lower precedence than any primary parent. Each alternative parent is associated with a separate resource tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractResource.MissingResourceException Exception indicating a required resource was not found.
protected static class	AbstractResource.MultipleFormEntry Implementation of ResourceEntry that supports multiple forms per entry.
static interface	AbstractResource.ResourceEntry Definition of a single entry for a resource.
static class	AbstractResource.ResourceList Encapsulates an ordered set of resources to search for translations.
protected static class	AbstractResource.SimpleEntry A simple resource entry with no alternate forms, only a key and a value.

Field Summary

Fields

Modifier and Type	Field and Description
protected GwtLocale	matchLocale
static int	REPORT_KEYS_THRESHOLD Error messages concerning missing keys should include the defined keys if the number of keys is below this threshold.

Constructor Summary

Constructors

Constructor and Description
AbstractResource(GwtLocale matchLocale)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractResource.ResourceEntry	getEntry(String key) Returns an entry in this resource.
protected static String	getExtendedKey(String key, String extension)
Collection<String>	getExtensions(String key)
String	getRequiredString(String key) Get a string and fail if not present.
String	getRequiredStringExt(String key, String extension) Get a string (with optional extension) and fail if not present.
String	getString(String key) Get a key.
abstract String	getStringExt(String key, String extension) Get a key with an extension.
Set<String>	keySet() Keys associated with this resource.
boolean	notEmpty() Returns true if this resource has any keys.
String	toString()
String	toVerboseString() A multi-line representation of this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Field Detail

REPORT_KEYS_THRESHOLD

public static final int REPORT_KEYS_THRESHOLD

Error messages concerning missing keys should include the defined keys if the number of keys is below this threshold.

See Also:

Constant Field Values

matchLocale

protected GwtLocale matchLocale

Constructor Detail

AbstractResource

public AbstractResource(GwtLocale matchLocale)

Method Detail

getExtendedKey

protected static String getExtendedKey(String key,
                    String extension)

getEntry

public AbstractResource.ResourceEntry getEntry(String key)

Returns an entry in this resource.

Parameters:

key -

Returns:

ResourceEntry instance

getExtensions

public Collection<String> getExtensions(String key)

Parameters:

key -

getRequiredString

public final String getRequiredString(String key)

Get a string and fail if not present.

Parameters:

key -

Returns:

the requested string

getRequiredStringExt

public final String getRequiredStringExt(String key,
                          String extension)

Get a string (with optional extension) and fail if not present.

Parameters:

key -

extension -

Returns:

the requested string

getString

public final String getString(String key)

Get a key.

Parameters:

key - key to lookup

Returns:

the string for the given key or null if not found

See Also:

ResourceBundle.getString(java.lang.String)

getStringExt

public abstract String getStringExt(String key,
                  String extension)

Get a key with an extension. Identical to getString() if extension is null.

Parameters:

key - to lookup

extension - extension of the key, nullable

Returns:

string or null

keySet

public Set<String> keySet()

Keys associated with this resource.

Returns:

keys

notEmpty

public boolean notEmpty()

Returns true if this resource has any keys.

toString

public String toString()

Overrides:

toString in class Object

toVerboseString

public String toVerboseString()

A multi-line representation of this object.

Returns:

verbose string