org.apache.velocity.tools.generic
Class LocaleConfig

java.lang.Object
  extended by org.apache.velocity.tools.generic.AbstractLockConfig
      extended by org.apache.velocity.tools.generic.LocaleConfig
Direct Known Subclasses:
ConversionTool, FormatConfig, ResourceTool

public class LocaleConfig
extends AbstractLockConfig

Implements common logic and constants for tools which allow their default Locale to be configured.

Author:
Nathan Bubna

Field Summary
static java.util.Locale DEFAULT_LOCALE
          The default Locale to be used when none is specified.
private  java.util.Locale locale
           
static java.lang.String LOCALE_KEY
          The key used for specifying a default locale via tool configuration.
 
Fields inherited from class org.apache.velocity.tools.generic.AbstractLockConfig
LOCK_CONFIG_KEY
 
Constructor Summary
LocaleConfig()
           
 
Method Summary
protected  void configure(ValueParser values)
          Does the actual configuration.
 java.util.Locale getLocale()
          This returns the configured default Locale 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.AbstractLockConfig
configure, isConfigLocked
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_LOCALE

public static final java.util.Locale DEFAULT_LOCALE
The default Locale to be used when none is specified.


LOCALE_KEY

public static final java.lang.String LOCALE_KEY
The key used for specifying a default locale via tool configuration.

See Also:
Constant Field Values

locale

private java.util.Locale locale
Constructor Detail

LocaleConfig

public LocaleConfig()
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.

Specified by:
configure in class AbstractLockConfig

getLocale

public java.util.Locale getLocale()
This returns the configured default Locale for this tool.

Returns:
the default Locale

setLocale

protected void setLocale(java.util.Locale locale)
Sets the default locale for this instance.



Copyright (c) 2003-2007 Apache Software Foundation