Class FormatConfig

Direct Known Subclasses:
BrowserTool, DateTool, MathTool, NumberTool

public class FormatConfig extends LocaleConfig
Implements common logic and constants for tools which allow their default format to be configured.
Since:
VelocityTools 2.0
Author:
Nathan Bubna
  • Field Details

    • DEFAULT_FORMAT

      public static final String DEFAULT_FORMAT
      The default format to be used when none is specified.
      See Also:
    • FORMAT_KEY

      public static final String FORMAT_KEY
      The key used for specifying a default format via tool configuration.
      See Also:
    • format

      private String format
  • Constructor Details

    • FormatConfig

      public FormatConfig()
  • 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 LocaleConfig
    • getFormat

      public String getFormat()
      This returns the configured default format for this tool.
      Returns:
      the default String
    • setFormat

      protected void setFormat(String format)
      Sets the default format for this instance.