Class LocaleConfig
- java.lang.Object
-
- org.apache.velocity.tools.generic.SafeConfig
-
- org.apache.velocity.tools.generic.LocaleConfig
-
- Direct Known Subclasses:
ConversionTool
,DisplayTool
,FormatConfig
,ResourceTool
public class LocaleConfig extends SafeConfig
Implements common logic and constants for tools which allow their defaultLocale
to be configured.- Since:
- VelocityTools 2.0
- Author:
- Nathan Bubna
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.Locale
DEFAULT_LOCALE
The defaultLocale
to be used when none is specified.private java.util.Locale
locale
-
Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY
-
-
Constructor Summary
Constructors Constructor Description LocaleConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
configure(ValueParser values)
Does the actual configuration.java.util.Locale
getLocale()
This returns the configured defaultLocale
for this tool.protected void
setLocale(java.util.Locale locale)
Sets the default locale for this instance.-
Methods inherited from class org.apache.velocity.tools.generic.SafeConfig
configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode
-
-
-
-
Method Detail
-
configure
protected void configure(ValueParser values)
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 classSafeConfig
-
getLocale
public java.util.Locale getLocale()
This returns the configured defaultLocale
for this tool.- Returns:
- the default
Locale
-
setLocale
protected void setLocale(java.util.Locale locale)
Sets the default locale for this instance.
-
-