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 default Locale to be configured.
Since:
VelocityTools 2.0
Author:
Nathan Bubna
  • Field Details

    • DEFAULT_LOCALE

      public static final Locale DEFAULT_LOCALE
      The default Locale to be used when none is specified.
    • locale

      private Locale locale
  • Constructor Details

    • LocaleConfig

      public LocaleConfig()
  • Method Details

    • 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 class SafeConfig
    • getLocale

      public Locale getLocale()
      This returns the configured default Locale for this tool.
      Returns:
      the default Locale
    • setLocale

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