Package org.geotools.util
Class ResourceInternationalString
- Object
-
- AbstractInternationalString
-
- ResourceInternationalString
-
- All Implemented Interfaces:
Serializable
,CharSequence
,Comparable<InternationalString>
,InternationalString
public class ResourceInternationalString extends AbstractInternationalString implements Serializable
An international string backed by a resource bundle. A resource bundle can be a Java class or a properties file, one for each language. The constructor expects the fully qualified class name of the base resource bundle (the one used when no resource was found in the client's language). The right resource bundle is loaded at runtime for the client's language by looking for a class or a properties file with the right suffix ("_en
" for English or "_fr
" for French). This mechanism is explained in J2SE's javadoc for thegetBundle
static method.Example: If a file named "
MyResources.properties
" exists in the package "org.geotools.mypackage
" and contains a line like "MyKey = some value
", then an international string for "some value
" can be created using the following code:InternationalString value = new ResourceInternationalString( "org.geotools.mypackage.MyResources", "MyKey");
some value
" string will be localized if the required properties files exist, for example "MyResources_fr.properties
" for French, "MyResources_it.properties
" for Italian, etc.- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ResourceInternationalString(String resources, String key)
Creates a new international string from the specified resource bundle and key.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object object)
Compares this international string with the specified object for equality.int
hashCode()
Returns a hash code value for this international text.String
toString(Locale locale)
Returns a string in the specified locale.-
Methods inherited from class AbstractInternationalString
charAt, compareTo, length, subSequence, toString
-
Methods inherited from interface CharSequence
chars, codePoints
-
-
-
-
Constructor Detail
-
ResourceInternationalString
public ResourceInternationalString(String resources, String key)
Creates a new international string from the specified resource bundle and key.- Parameters:
resources
- The name of the resource bundle, as a fully qualified class name.key
- The key for the resource to fetch.
-
-
Method Detail
-
toString
public String toString(Locale locale) throws MissingResourceException
Returns a string in the specified locale. If there is no string for the specifiedlocale
, then this method search for a string in an other locale as specified in theResourceBundle
class description.- Specified by:
toString
in interfaceInternationalString
- Specified by:
toString
in classAbstractInternationalString
- Parameters:
locale
- The locale to look for, ornull
for an unlocalized version.- Returns:
- The string in the specified locale, or in a default locale.
- Throws:
MissingResourceException
- is the key given to the constructor is invalid.
-
equals
public boolean equals(Object object)
Compares this international string with the specified object for equality.
-
-