public class ResourceBundle extends Object
Wrapper class for resource bundles. Property files are used to store resource strings, which are the only types of resources available. Property files can inherit properties from other files so that a base property file can be used and a small number of properties can be over-ridden by another property file. For example you may create an english version of a resource file named "resource.properties". You then decide that the British English version of all of the properties except one are the same, so there is no need to redefine all of the properties in "resource_en_GB", just the one that is different.
The property file lookup searches for classes with various suffixes on the basis if the desired local and the current default local (as returned by Local.getDefault()). As property files are found the property values are merged so that inheritance is preserved.
The order of searching is:
The basename is the name of the property file without the ".properties" extension.
Properties will be cached for performance.
Property values stored in the property files can also contain dynamic variables. Any dynamic variable defined in PropertiesUtil.getVariableValue() can be used (such as {date}), as well as arguments in the form {0}, {1}, etc. Argument values are specified in the various overloaded getString() methods.
Modifier and Type | Field and Description |
---|---|
static String |
BASE_NAME |
protected String |
basePropertyFileName |
static String |
PROPERTY_EXT |
protected Properties |
resourceProperties |
Constructor and Description |
---|
ResourceBundle(Object caller,
String name)
Construct a new RB
|
ResourceBundle(Object caller,
String name,
Locale locale)
Construct a new RB
|
ResourceBundle(String name)
Construct a new RB
|
Modifier and Type | Method and Description |
---|---|
static void |
clearCache()
Clears the internal cache.
|
static String |
getMessage(Object caller,
String basename,
Locale locale,
String key,
Object[] args) |
Properties |
getProperties()
Get the underlying properties
|
static String |
getString(Object caller,
Locale locale,
String key)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
Locale locale,
String key,
Object arg0)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
Locale locale,
String key,
Object[] args)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
Locale locale,
String key,
Object arg0,
Object arg1)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
Locale locale,
String key,
Object arg0,
Object arg1,
Object arg2)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
Locale locale,
String key,
Object arg0,
Object arg1,
Object arg2,
Object arg3)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
Locale locale,
String key,
Object arg0,
Object arg1,
Object arg2,
Object arg3,
Object arg4)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key,
Object arg0)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key,
Object[] args)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key,
Object arg0,
Object arg1)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key,
Object arg0,
Object arg1,
Object arg2)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key,
Object arg0,
Object arg1,
Object arg2,
Object arg3)
Get a message from resource.properties from the package of the given object.
|
static String |
getString(Object caller,
String key,
Object arg0,
Object arg1,
Object arg2,
Object arg3,
Object arg4)
Get a message from resource.properties from the package of the given object.
|
String |
getString(String key)
Gets a string message from the resource bundle for the given key
|
String |
getString(String key,
Object arg0)
Gets a string message from the resource bundle for the given key.
|
String |
getString(String key,
Object[] array)
Gets a string message from the resource bundle for the given key.
|
String |
getString(String key,
Object arg0,
Object arg1)
Gets a string message from the resource bundle for the given key.
|
String |
getString(String key,
Object arg0,
Object arg1,
Object arg2)
Gets a string message from the resource bundle for the given key.
|
protected Properties |
loadProperties(String resname,
ClassLoader loader) |
protected void |
loadProperties(String basename,
ClassLoader loader,
Locale locale,
Locale defaultLocale) |
protected Properties |
loadProperties(String basename,
ClassLoader loader,
Locale locale,
Properties props) |
protected Properties |
merge(Properties p1,
Properties p2)
Merge two Properties objects
|
public static final String BASE_NAME
public static final String PROPERTY_EXT
protected String basePropertyFileName
protected Properties resourceProperties
public ResourceBundle(String name)
name
- The name of the property file without the ".properties" extensionpublic ResourceBundle(Object caller, String name)
caller
- The calling object. This is used to get the package name
to further construct the basename as well as to get the proper ClassLoadername
- The name of the property file without the ".properties" extensionpublic ResourceBundle(Object caller, String name, Locale locale)
caller
- The calling object. This is used to get the package name
to further construct the basename as well as to get the proper ClassLoadername
- The name of the property file without the ".properties" extensionlocale
- The localepublic String getString(String key)
key
- The resource keypublic String getString(String key, Object arg0)
Gets a string message from the resource bundle for the given key. The message may contain variables that will be substituted with the given arguments. Variables have the format:
key
- The resource keyarg0
- The argument to place in variable {0}public String getString(String key, Object arg0, Object arg1)
Gets a string message from the resource bundle for the given key. The message may contain variables that will be substituted with the given arguments. Variables have the format:
key
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}public String getString(String key, Object arg0, Object arg1, Object arg2)
Gets a string message from the resource bundle for the given key. The message may contain variables that will be substituted with the given arguments. Variables have the format:
key
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {1}public String getString(String key, Object[] array)
Gets a string message from the resource bundle for the given key. The message may contain variables that will be substituted with the given arguments. Variables have the format:
key
- The resource keyarray
- An array of objects to place in corresponding variablesprotected void loadProperties(String basename, ClassLoader loader, Locale locale, Locale defaultLocale)
protected Properties loadProperties(String basename, ClassLoader loader, Locale locale, Properties props)
protected Properties loadProperties(String resname, ClassLoader loader)
protected Properties merge(Properties p1, Properties p2)
public Properties getProperties()
public static String getString(Object caller, String key)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keypublic static String getString(Object caller, String key, Object arg0)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keyarg0
- The argument to place in variable {0}public static String getString(Object caller, String key, Object arg0, Object arg1)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}public static String getString(Object caller, String key, Object arg0, Object arg1, Object arg2)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {2}public static String getString(Object caller, String key, Object arg0, Object arg1, Object arg2, Object arg3)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {2}arg3
- The argument to place in variable {3}public static String getString(Object caller, String key, Object arg0, Object arg1, Object arg2, Object arg3, Object arg4)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {2}arg3
- The argument to place in variable {3}arg4
- The argument to place in variable {4}public static String getString(Object caller, String key, Object[] args)
caller
- The calling object, used to get the package name and class loaderkey
- The resource keyargs
- An array of objects to place in corresponding variablespublic static String getString(Object caller, Locale locale, String key)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keypublic static String getString(Object caller, Locale locale, String key, Object arg0)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keyarg0
- The argument to place in variable {0}public static String getString(Object caller, Locale locale, String key, Object arg0, Object arg1)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}public static String getString(Object caller, Locale locale, String key, Object arg0, Object arg1, Object arg2)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {2}public static String getString(Object caller, Locale locale, String key, Object arg0, Object arg1, Object arg2, Object arg3)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {2}arg3
- The argument to place in variable {3}public static String getString(Object caller, Locale locale, String key, Object arg0, Object arg1, Object arg2, Object arg3, Object arg4)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keyarg0
- The argument to place in variable {0}arg1
- The argument to place in variable {1}arg2
- The argument to place in variable {2}arg3
- The argument to place in variable {3}public static String getString(Object caller, Locale locale, String key, Object[] args)
caller
- The calling object, used to get the package name and class loaderlocale
- The localekey
- The resource keyargs
- An array of objects to place in corresponding variablespublic static String getMessage(Object caller, String basename, Locale locale, String key, Object[] args)
public static void clearCache()
Copyright © 2016 WSO2 Inc. All rights reserved.