Class ResourceTool
java.lang.Object
org.apache.velocity.tools.generic.SafeConfig
org.apache.velocity.tools.generic.LocaleConfig
org.apache.velocity.tools.generic.ResourceTool
- Direct Known Subclasses:
ViewResourceTool
Tool for accessing ResourceBundles and formatting messages therein.
Template example(s): $text.foo -> bar $text.hello.world -> Hello World! $text.keys -> [foo, hello.world, world] #set( $otherText = $text.bundle('otherBundle') ) $otherText.foo -> woogie $otherText.bar -> The args are {0} and {1}. $otherText.bar.insert(4) -> The args are 4 and {1}. $otherText.bar.insert(4,true) -> The args are 4 and true. Toolbox configuration example: <tools> <toolbox scope="request"> <tool class="org.apache.velocity.tools.generic.ResourceTool" bundles="resources,com.foo.moreResources" locale="en_US"/> </toolbox> </tools>
This comes in very handy when internationalizing templates. Note that the default resource bundle baseName is "resources", and the default locale is either:
- the result of HttpServletRequest.getLocale() (if used in request scope of a VelocityView app)
- the configured locale for this tool (as shown above)
- the configured locale for the toolbox this tool is in
- the configured locale for the toolbox factory managing this tool
- the system locale, if none of the above
Also, be aware that very few performance considerations have been made in this initial version. It should do fine, but if you have performance issues, please report them to dev@velocity.apache.org, so we can make improvements.
- Since:
- VelocityTools 1.3
- Version:
- $Revision: 722509 $ $Date: 2006-11-27 10:49:37 -0800 (Mon, 27 Nov 2006) $
- Author:
- Nathan Bubna
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionfinal class
Internal class used to enable an elegant syntax for accessing resources. -
Field Summary
FieldsFields inherited from class org.apache.velocity.tools.generic.LocaleConfig
DEFAULT_LOCALE
Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
configure
(ValueParser parser) Does the actual configuration.Accepts objects and uses their string value as the key.Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found.Returns the value for the specified key in the ResourceBundle for the specified basename and locale.protected ResourceBundle
Retrieves theResourceBundle
for the specified baseName and locale, if such exists.protected final String
protected final Locale
Deprecated.getKeys()
Returns aList
of the key strings in the specified ResourceBundles.Returns aList
of the key strings in the ResourceBundle with the specified baseName and locale.Renders the specified resource value and arguments as a String.protected final void
setDefaultBundle
(String bundle) protected final void
setDefaultLocale
(Locale locale) Deprecated.void
setDeprecationSupportMode
(boolean depMode) Deprecated.private Locale
Methods inherited from class org.apache.velocity.tools.generic.LocaleConfig
getLocale, setLocale
Methods inherited from class org.apache.velocity.tools.generic.SafeConfig
configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode
-
Field Details
-
BUNDLES_KEY
- See Also:
-
bundles
-
deprecationSupportMode
private boolean deprecationSupportMode
-
-
Constructor Details
-
ResourceTool
public ResourceTool()
-
-
Method Details
-
setDefaultBundle
-
getDefaultBundle
-
setDefaultLocale
Deprecated. -
getDefaultLocale
Deprecated. -
setDeprecationSupportMode
Deprecated. -
configure
Description copied from class:LocaleConfig
Does the actual configuration. This is protected, so subclasses may share the same ValueParser and call configure at any time, while preventing templates from doing so when configure(Map) is locked.- Overrides:
configure
in classLocaleConfig
-
get
Accepts objects and uses their string value as the key. -
get
-
getKeys
-
bundle
-
locale
-
insert
-
insert
-
insert
-
insert
-
getBundle
Retrieves theResourceBundle
for the specified baseName and locale, if such exists. If the baseName or locale is null or if the locale argument cannot be converted to aLocale
, then this will return null. -
get
Returns the value for the specified key in the ResourceBundle for the specified basename and locale. If no such resource can be found, no errors are thrown andnull
is returned.- Parameters:
key
- the key for the requested resourcebaseName
- the base name of the resource bundle to searchloc
- the locale to use
-
get
Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found. If no resource is found, no exception will be thrown andnull
will be returned.- Parameters:
k
- the key for the requested resourcebundles
- the resource bundles to searchl
- the locale to use
-
getKeys
Returns aList
of the key strings in the ResourceBundle with the specified baseName and locale. If the specified prefix is not null, then this will skip any keys that do not begin with that prefix and trim the prefix and any subsequent '.' off of the remaining ones. If the prefix is null, then no filtering or trimming will be done.- Parameters:
prefix
- the prefix for the requested keysbundles
- the resource bundles to searchloc
- the locale to use
-
getKeys
Returns aList
of the key strings in the specified ResourceBundles. If the specified prefix is not null, then this will skip any keys that do not begin with that prefix and trim the prefix and any subsequent '.' off of the remaining ones. If the prefix is null, then no filtering or trimming will be done.- Parameters:
prefix
- the prefix for the requested keysbundles
- the resource bundles to searchloc
- the locale to use- See Also:
-
toLocale
-
render
Renders the specified resource value and arguments as a String. The resource is treated as aMessageFormat
pattern which is used for formatting along with any specified argument values. IfdeprecationSupportMode
is set to true, then this will return the resource directly when there are no args (as it did in 1.x versions).
-