Class Configurable

  • Direct Known Subclasses:
    Configuration, Environment, Template

    public class Configurable
    extends Object
    This is a common superclass of Configuration, Template, and Environment classes. It provides settings that are common to each of them. FreeMarker uses a three-level setting hierarchy - the return value of every setting getter method on Configurable objects inherits its value from its parent Configurable object, unless explicitly overridden by a call to a corresponding setter method on the object itself. The parent of an Environment object is a Template object, the parent of a Template object is a Configuration object.
    • Field Detail

      • LOCALE_KEY_SNAKE_CASE

        public static final String LOCALE_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • LOCALE_KEY_CAMEL_CASE

        public static final String LOCALE_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • LOCALE_KEY

        public static final String LOCALE_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • NUMBER_FORMAT_KEY_SNAKE_CASE

        public static final String NUMBER_FORMAT_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • NUMBER_FORMAT_KEY_CAMEL_CASE

        public static final String NUMBER_FORMAT_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • NUMBER_FORMAT_KEY

        public static final String NUMBER_FORMAT_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • TIME_FORMAT_KEY_SNAKE_CASE

        public static final String TIME_FORMAT_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • TIME_FORMAT_KEY_CAMEL_CASE

        public static final String TIME_FORMAT_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • TIME_FORMAT_KEY

        public static final String TIME_FORMAT_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • DATE_FORMAT_KEY_SNAKE_CASE

        public static final String DATE_FORMAT_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • DATE_FORMAT_KEY_CAMEL_CASE

        public static final String DATE_FORMAT_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • DATE_FORMAT_KEY

        public static final String DATE_FORMAT_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • DATETIME_FORMAT_KEY_SNAKE_CASE

        public static final String DATETIME_FORMAT_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • DATETIME_FORMAT_KEY_CAMEL_CASE

        public static final String DATETIME_FORMAT_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • DATETIME_FORMAT_KEY

        public static final String DATETIME_FORMAT_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • TIME_ZONE_KEY_SNAKE_CASE

        public static final String TIME_ZONE_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • TIME_ZONE_KEY_CAMEL_CASE

        public static final String TIME_ZONE_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • TIME_ZONE_KEY

        public static final String TIME_ZONE_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • SQL_DATE_AND_TIME_TIME_ZONE_KEY_SNAKE_CASE

        public static final String SQL_DATE_AND_TIME_TIME_ZONE_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • SQL_DATE_AND_TIME_TIME_ZONE_KEY_CAMEL_CASE

        public static final String SQL_DATE_AND_TIME_TIME_ZONE_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • SQL_DATE_AND_TIME_TIME_ZONE_KEY

        public static final String SQL_DATE_AND_TIME_TIME_ZONE_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • CLASSIC_COMPATIBLE_KEY_SNAKE_CASE

        public static final String CLASSIC_COMPATIBLE_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • CLASSIC_COMPATIBLE_KEY_CAMEL_CASE

        public static final String CLASSIC_COMPATIBLE_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • CLASSIC_COMPATIBLE_KEY

        public static final String CLASSIC_COMPATIBLE_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE

        public static final String TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • TEMPLATE_EXCEPTION_HANDLER_KEY_CAMEL_CASE

        public static final String TEMPLATE_EXCEPTION_HANDLER_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • TEMPLATE_EXCEPTION_HANDLER_KEY

        public static final String TEMPLATE_EXCEPTION_HANDLER_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • ARITHMETIC_ENGINE_KEY_SNAKE_CASE

        public static final String ARITHMETIC_ENGINE_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • ARITHMETIC_ENGINE_KEY_CAMEL_CASE

        public static final String ARITHMETIC_ENGINE_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • ARITHMETIC_ENGINE_KEY

        public static final String ARITHMETIC_ENGINE_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • OBJECT_WRAPPER_KEY_SNAKE_CASE

        public static final String OBJECT_WRAPPER_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • OBJECT_WRAPPER_KEY_CAMEL_CASE

        public static final String OBJECT_WRAPPER_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • OBJECT_WRAPPER_KEY

        public static final String OBJECT_WRAPPER_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • BOOLEAN_FORMAT_KEY_SNAKE_CASE

        public static final String BOOLEAN_FORMAT_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • BOOLEAN_FORMAT_KEY_CAMEL_CASE

        public static final String BOOLEAN_FORMAT_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • BOOLEAN_FORMAT_KEY

        public static final String BOOLEAN_FORMAT_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • OUTPUT_ENCODING_KEY_SNAKE_CASE

        public static final String OUTPUT_ENCODING_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • OUTPUT_ENCODING_KEY_CAMEL_CASE

        public static final String OUTPUT_ENCODING_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • OUTPUT_ENCODING_KEY

        public static final String OUTPUT_ENCODING_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • URL_ESCAPING_CHARSET_KEY_SNAKE_CASE

        public static final String URL_ESCAPING_CHARSET_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • URL_ESCAPING_CHARSET_KEY_CAMEL_CASE

        public static final String URL_ESCAPING_CHARSET_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • URL_ESCAPING_CHARSET_KEY

        public static final String URL_ESCAPING_CHARSET_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
        See Also:
        Constant Field Values
      • STRICT_BEAN_MODELS_KEY_SNAKE_CASE

        public static final String STRICT_BEAN_MODELS_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • STRICT_BEAN_MODELS_KEY_CAMEL_CASE

        public static final String STRICT_BEAN_MODELS_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • STRICT_BEAN_MODELS_KEY

        public static final String STRICT_BEAN_MODELS_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints. @since 2.3.22
        See Also:
        Constant Field Values
      • AUTO_FLUSH_KEY_SNAKE_CASE

        public static final String AUTO_FLUSH_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • AUTO_FLUSH_KEY_CAMEL_CASE

        public static final String AUTO_FLUSH_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • AUTO_FLUSH_KEY

        public static final String AUTO_FLUSH_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints. @since 2.3.17
        See Also:
        Constant Field Values
      • NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE

        public static final String NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE

        public static final String NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • NEW_BUILTIN_CLASS_RESOLVER_KEY

        public static final String NEW_BUILTIN_CLASS_RESOLVER_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints. @since 2.3.17
        See Also:
        Constant Field Values
      • SHOW_ERROR_TIPS_KEY_SNAKE_CASE

        public static final String SHOW_ERROR_TIPS_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • SHOW_ERROR_TIPS_KEY_CAMEL_CASE

        public static final String SHOW_ERROR_TIPS_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • SHOW_ERROR_TIPS_KEY

        public static final String SHOW_ERROR_TIPS_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints. @since 2.3.21
        See Also:
        Constant Field Values
      • API_BUILTIN_ENABLED_KEY_SNAKE_CASE

        public static final String API_BUILTIN_ENABLED_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • API_BUILTIN_ENABLED_KEY_CAMEL_CASE

        public static final String API_BUILTIN_ENABLED_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • API_BUILTIN_ENABLED_KEY

        public static final String API_BUILTIN_ENABLED_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints. @since 2.3.22
        See Also:
        Constant Field Values
      • LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE

        public static final String LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE
        Legacy, snake case (like_this) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE

        public static final String LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE
        Modern, camel case (likeThis) variation of the setting name. @since 2.3.23
        See Also:
        Constant Field Values
      • LOG_TEMPLATE_EXCEPTIONS_KEY

        public static final String LOG_TEMPLATE_EXCEPTIONS_KEY
        Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints. @since 2.3.22
        See Also:
        Constant Field Values
    • Constructor Detail

      • Configurable

        public Configurable()
        Deprecated.
        This shouldn't even be public; don't use it.
        Creates a top-level configurable, one that doesn't inherit from a parent, and thus stores the default values.
      • Configurable

        protected Configurable​(Version incompatibleImprovements)
        Intended to be called from inside FreeMarker only. Creates a top-level configurable, one that doesn't inherit from a parent, and thus stores the default values. Called by the Configuration constructor.
      • Configurable

        public Configurable​(Configurable parent)
        Creates a new instance. Normally you do not need to use this constructor, as you don't use Configurable directly, but its subclasses.
    • Method Detail

      • getParent

        public final Configurable getParent()
        Returns the parent Configurable object of this object. The parent stores the default setting values for this Configurable. For example, the parent of a Template object is a Configuration object, so values not specified on Template-level are get from the Configuration object.

        Note on the parent of Environment: If you set incompatible_improvements to at least 2.3.22, it will be always the "main" Template, that is, the template for whose processing the Environment was created. With lower incompatible_improvements, the current parent can temporary change during template execution, for example when your are inside an #include-d template (among others). Thus, don't build on which Template the parent of Environment is during template execution, unless you set incompatible_improvements to 2.3.22 or higher.

        Returns:
        The parent Configurable object, or null if this is the root Configurable object (i.e, if it's the Configuration object).
      • setClassicCompatible

        public void setClassicCompatible​(boolean classicCompatibility)
        Toggles the "Classic Compatible" mode. For a comprehensive description of this mode, see isClassicCompatible().
      • setClassicCompatibleAsInt

        public void setClassicCompatibleAsInt​(int classicCompatibility)
        Same as setClassicCompatible(boolean), but allows some extra values.
        Parameters:
        classicCompatibility - 0 means false, 1 means true, 2 means true but with emulating bugs in early 2.x classic-compatibility mode. Currently 2 affects how booleans are converted to string; with 1 it's always "true"/"", but with 2 it's "true"/"false" for values wrapped by BeansWrapper as then Boolean.toString() prevails. Note that someBoolean?string will always consistently format the boolean according the boolean_format setting, just like in FreeMarker 2.3 and later.
      • isClassicCompatible

        public boolean isClassicCompatible()
        Returns whether the engine runs in the "Classic Compatibile" mode. When this mode is active, the engine behavior is altered in following way: (these resemble the behavior of the 1.7.x line of FreeMarker engine, now named "FreeMarker Classic", hence the name).
        • handle undefined expressions gracefully. Namely when an expression "expr" evaluates to null:
          • in <assign varname=expr> directive, or in ${expr} directive, or in otherexpr == expr, or in otherexpr != expr, or in hash[expr], or in expr[keyOrIndex] (since 2.3.20), or in expr.key (since 2.3.20), then it's treated as empty string.
          • as argument of <list expr as item> or <foreach item in expr>, the loop body is not executed (as if it were a 0-length list)
          • as argument of <if> directive, or on other places where a boolean expression is expected, it's treated as false
        • Non-boolean models are accepted in <if> directive, or as operands of logical operators. "Empty" models (zero-length string, empty sequence or hash) are evaluated as false, all others are evaluated as true.
        • When boolean value is treated as a string (i.e. output in ${...} directive, or concatenated with other string), true values are converted to string "true", false values are converted to empty string. Except, if the value of the setting is 2, it will be formatted according the boolean_format setting, just like in 2.3.20 and later.
        • Scalar models supplied to <list> and <foreach> are treated as a one-element list consisting of the passed model.
        • Paths parameter of <include> will be interpreted as absolute path.
        In all other aspects, the engine is a 2.1 engine even in compatibility mode - you don't lose any of the new functionality by enabling it.
      • getClassicCompatibleAsInt

        public int getClassicCompatibleAsInt()
      • setLocale

        public void setLocale​(Locale locale)
        Sets the default locale used for number and date formatting (among others), also the locale used for searching localized template variations when no locale was explicitly requested.
        See Also:
        Configuration.getTemplate(String, Locale)
      • setSQLDateAndTimeTimeZone

        public void setSQLDateAndTimeTimeZone​(TimeZone tz)
        Sets the time zone used when dealing with java.sql.Date and java.sql.Time values. It defaults to null for backward compatibility, but in most application this should be set to the JVM default time zone (server default time zone), because that's what most JDBC drivers will use when constructing the java.sql.Date and java.sql.Time values. If this setting is null, FreeMarker will use the value of (getTimeZone()) for java.sql.Date and java.sql.Time values, which often gives bad results.

        This setting doesn't influence the formatting of other kind of values (like of java.sql.Timestamp or plain java.util.Date values).

        To decide what value you need, a few things has to be understood:

        • Date-only and time-only values in SQL-oriented databases are usually store calendar and clock field values directly (year, month, day, or hour, minute, seconds (with decimals)), as opposed to a set of points on the physical time line. Thus, unlike SQL timestamps, these values usually aren't meant to be shown differently depending on the time zone of the audience.
        • When a JDBC query has to return a date-only or time-only value, it has to convert it to a point on the physical time line, because that's what Date and its subclasses store (milliseconds since the epoch). Obviously, this is impossible to do. So JDBC just chooses a physical time which, when rendered with the JVM default time zone, will give the same field values as those stored in the database. (Actually, you can give JDBC a calendar, and so it can use other time zones too, but most application won't care using those overloads.) For example, assume that the system time zone is GMT+02:00. Then, 2014-07-12 in the database will be translated to physical time 2014-07-11 22:00:00 UTC, because that rendered in GMT+02:00 gives 2014-07-12 00:00:00. Similarly, 11:57:00 in the database will be translated to physical time 1970-01-01 09:57:00 UTC. Thus, the physical time stored in the returned value depends on the default system time zone of the JDBC client, not just on the content in the database. (This used to be the default behavior of ORM-s, like Hibernate, too.)
        • The value of the time_zone FreeMarker configuration setting sets the time zone used for the template output. For example, when a web page visitor has a preferred time zone, the web application framework may calls Environment.setTimeZone(TimeZone) with that time zone. Thus, the visitor will see java.sql.Timestamp and plain java.util.Date values as they look in his own time zone. While this is desirable for those types, as they meant to represent physical points on the time line, this is not necessarily desirable for date-only and time-only values. When sql_date_and_time_time_zone is null, time_zone is used for rendering all kind of date/time/dateTime values, including java.sql.Date and java.sql.Time, and then if, for example, time_zone is GMT+00:00, the values from the earlier examples will be shown as 2014-07-11 (one day off) and 09:57:00 (2 hours off). While those are the time zone correct renderings, those values probably was meant to shown "as is".
        • You may wonder why this setting isn't simply "SQL time zone", since the time zone related behavior of JDBC applies to java.sql.Timestamp too. FreeMarker assumes that you have set up your application so that time stamps coming from the database go through the necessary conversion to store the correct distance from the epoch (1970-01-01 00:00:00 UTC), as requested by Date. In that case the time stamp can be safely rendered in different time zones, and thus it needs no special treatment.
        Parameters:
        tz - Maybe null, in which case java.sql.Date and java.sql.Time values will be formatted in the time zone returned by getTimeZone(). (Note that since null is an allowed value for this setting, it will not cause getSQLDateAndTimeTimeZone() to fall back to the parent configuration.)
        Since:
        2.3.21
        See Also:
        setTimeZone(TimeZone)
      • getLocale

        public Locale getLocale()
        Returns the assumed locale when searching for template files with no explicit requested locale. Defaults to system locale.
      • setBooleanFormat

        public void setBooleanFormat​(String booleanFormat)
        The string value for the boolean true and false values, intended for human audience (not for a computer language), separated with comma. For example, "yes,no". Note that white-space is significant, so "yes, no" is WRONG (unless you want that leading space before "no").

        For backward compatibility the default is "true,false", but using that value is denied for automatic boolean-to-string conversion (like ${myBoolean} will fail with it), only myBool?string will allow it, which is deprecated since FreeMarker 2.3.20.

        Note that automatic boolean-to-string conversion only exists since FreeMarker 2.3.20. Earlier this setting only influenced the result of myBool?string.

      • setTimeFormat

        public void setTimeFormat​(String timeFormat)
        Sets the format used to convert Date-s to string-s that are time (no date part) values, also the format that someString?time will use to parse strings.

        For the possible values see setDateTimeFormat(String).

        Defaults to "", which means "use the FreeMarker default", which is currently "medium".

      • setDateFormat

        public void setDateFormat​(String dateFormat)
        Sets the format used to convert Date-s to string-s that are date (no time part) values, also the format that someString?date will use to parse strings.

        For the possible values see setDateTimeFormat(String).

        Defaults to "", which means "use the FreeMarker default", which is currently "code".

      • setDateTimeFormat

        public void setDateTimeFormat​(String dateTimeFormat)
        Sets the format used to convert Date-s to string-s that are date-time (timestamp) values, also the format that someString?datetime will use to parse strings.

        The possible setting values are (the quotation marks aren't part of the value itself):

        • Patterns accepted by Java's SimpleDateFormat, for example "dd.MM.yyyy HH:mm:ss" (where HH means 24 hours format) or "MM/dd/yyyy hh:mm:ss a" (where a prints AM or PM, if the current language is English).

        • "xs" for XML Schema format, or "iso" for ISO 8601:2004 format. These formats allow various additional options, separated with space, like in "iso m nz" (or with _, like in "iso_m_nz"; this is useful in a case like lastModified?string.iso_m_nz). The options and their meanings are:

          • Accuracy options:
            ms = Milliseconds, always shown with all 3 digits, even if it's all 0-s. Example: 13:45:05.800
            s = Seconds (fraction seconds are dropped even if non-0), like 13:45:05
            m = Minutes, like 13:45. This isn't allowed for "xs".
            h = Hours, like 13. This isn't allowed for "xs".
            Neither = Up to millisecond accuracy, but trailing millisecond 0-s are removed, also the whole milliseconds part if it would be 0 otherwise. Example: 13:45:05.8

          • Time zone offset visibility options:
            fz = "Force Zone", always show time zone offset (even for for java.sql.Date and java.sql.Time values). But, because ISO 8601 doesn't allow for dates (means date without time of the day) to show the zone offset, this option will have no effect in the case of "iso" with dates.
            nz = "No Zone", never show time zone offset
            Neither = always show time zone offset, except for java.sql.Date and java.sql.Time, and for "iso" date values.

          • Time zone options:
            u = Use UTC instead of what the time_zone setting suggests. However, java.sql.Date and java.sql.Time aren't affected by this (see setSQLDateAndTimeTimeZone(TimeZone) to understand why)
            fu = "Force UTC", that is, use UTC instead of what the time_zone or the sql_date_and_time_time_zone setting suggests. This also effects java.sql.Date and java.sql.Time values
            Neither = Use the time zone suggested by the time_zone or the sql_date_and_time_time_zone configuration setting (setTimeZone(TimeZone) and setSQLDateAndTimeTimeZone(TimeZone)).

          The options can be specified in any order.

          Options from the same category are mutually exclusive, like using m and s together is an error.

          The accuracy and time zone offset visibility options don't influence parsing, only formatting. For example, even if you use "iso m nz", "2012-01-01T15:30:05.125+01" will be parsed successfully and with milliseconds accuracy. The time zone options (like "u") influence what time zone is chosen only when parsing a string that doesn't contain time zone offset.

          Parsing with "iso" understands both extend format and basic format, like 20141225T235018. It doesn't, however, support the parsing of all kind of ISO 8601 strings: if there's a date part, it must use year, month and day of the month values (not week of the year), and the day can't be omitted.

          The output of "iso" is deliberately so that it's also a good representation of the value with XML Schema format, except for 0 and negative years, where it's impossible. Also note that the time zone offset is omitted for date values in the "iso" format, while it's preserved for the "xs" format.

        • "short", "medium", "long", or "full", which that has locale-dependent meaning defined by the Java platform (see in the documentation of DateFormat). For date-time values, you can specify the length of the date and time part independently, be separating them with _, like "short_medium". ("medium" means "medium_medium" for date-time values.)

        Defaults to "", which means "use the FreeMarker default", which is currently "code".

      • setOutputEncoding

        public void setOutputEncoding​(String outputEncoding)
        Informs FreeMarker about the charset used for the output. As FreeMarker outputs character stream (not byte stream), it's not aware of the output charset unless the software that encloses it tells it with this setting. Some templates may use FreeMarker features that require this information. Setting this to null means that the output encoding is not known.

        Defaults to null (unknown).

      • getOutputEncoding

        public String getOutputEncoding()
      • setURLEscapingCharset

        public void setURLEscapingCharset​(String urlEscapingCharset)
        Sets the URL escaping charset. If not set (null), the output encoding (setOutputEncoding(String)) will be used for URL escaping. Defaults to null.
      • getURLEscapingCharset

        public String getURLEscapingCharset()
      • getNewBuiltinClassResolver

        public TemplateClassResolver getNewBuiltinClassResolver()
        Retrieves the TemplateClassResolver used to resolve classes when "SomeClassName"?new is called in a template.
        Since:
        2.3.17
      • setAutoFlush

        public void setAutoFlush​(boolean autoFlush)
        Sets whether the output Writer is automatically flushed at the end of Template.process(Object, Writer) (and its overloads). The default is true.

        Using false is needed for example when a Web page is composed from several boxes (like portlets, GUI panels, etc.) that aren't inserted with #include (or with similar directives) into a master FreeMarker template, rather they are all processed with a separate Template.process(Object, Writer) call. In a such scenario the automatic flushes would commit the HTTP response after each box, hence interfering with full-page buffering, and also possibly decreasing performance with too frequent and too early response buffer flushes.

        Since:
        2.3.17
      • setShowErrorTips

        public void setShowErrorTips​(boolean showTips)
        Sets if tips should be shown in error messages of errors arising during template processing. The default is true.
        Since:
        2.3.21
      • setAPIBuiltinEnabled

        public void setAPIBuiltinEnabled​(boolean value)
        Specifies if ?api can be used in templates. Defaults to false so that updating FreeMarker won't decrease the security of existing applications.
        Since:
        2.3.22
      • setLogTemplateExceptions

        public void setLogTemplateExceptions​(boolean value)
        Specifies if TemplateException-s thrown by template processing are logged by FreeMarker or not. The default is true for backward compatibility, but that results in logging the exception twice in properly written applications, because there the TemplateException thrown by the public FreeMarker API is also logged by the caller (even if only as the cause exception of a higher level exception). Hence, in modern applications it should be set to false. Note that this setting has no effect on the logging of exceptions caught by #attempt; those are always logged, no mater what (because those exceptions won't bubble up until the API caller).
        Since:
        2.3.22
      • setSetting

        public void setSetting​(String name,
                               String value)
                        throws TemplateException
        Sets a FreeMarker setting by a name and string value. If you can configure FreeMarker directly with Java (or other programming language), you should use the dedicated setter methods instead (like setObjectWrapper(ObjectWrapper). This meant to be used if you get the settings from somewhere as text. Regardless, below you will find an overview of the settings available no matter how you set them.

        Note: As of FreeMarker 2.3.23, setting names can be written in camel case too. For example, instead of date_format you can also use dateFormat. It's likely that camel case will become to the recommended convention in the future.

        The list of settings commonly supported in all Configurable subclasses:

        Configuration (a subclass of Configurable) also understands these:

        Regarding object builder expressions (used by the setting values where it was indicated):

        • Before FreeMarker 2.3.21 it had to be a fully qualified class name, and nothing else.

        • Since 2.3.21, the generic syntax is: className(constrArg1, constrArg2, ... constrArgN, propName1=propValue1, propName2=propValue2, ... propNameN=propValueN), where className is the fully qualified class name of the instance to create (except if we have builder class or INSTANCE field around, but see that later), constrArg-s are the values of constructor arguments, and propName=propValue-s set JavaBean properties (like x=1 means setX(1)) on the created instance. You can have any number of constructor arguments and property setters, including 0. Constructor arguments must precede any property setters.

        • Example: com.example.MyObjectWrapper(1, 2, exposeFields=true, cacheSize=5000) is nearly equivalent with this Java code: obj = new com.example.MyObjectWrapper(1, 2); obj.setExposeFields(true); obj.setCacheSize(5000);
        • If you have no constructor arguments and property setters, and the className class has a public static INSTANCE field, the value of that filed will be the value of the expression, and the constructor won't be called. Note that if you use the backward compatible syntax, where these's no parenthesis after the class name, then it will not look for INSTANCE.

        • If there exists a class named classNameBuilder, then that class will be instantiated instead with the given constructor arguments, and the JavaBean properties of that builder instance will be set. After that, the public build() method of the instance will be called, whose return value will be the value of the whole expression. (The builder class and the build() method is simply found by name, there's no special interface to implement.) Note that if you use the backward compatible syntax, where these's no parenthesis after the class name, then it will not look for builder class.

        • Currently, the values of arguments and properties can only be one of these:

          • A numerical literal, like 123 or -1.5. Like in FTL, there are no numerical types, the value will be automatically converted to the type of the target.
          • A boolean literal: true or false
          • The null literal: null
          • A string literal with FTL syntax, except that it can't contain ${...}-s and #{...}-s. Examples: "Line 1\nLine 2" or r"C:\temp".
          • An object builder expression. That is, object builder expressions can be nested into each other.
        • The top-level object builder expressions may omit (). In that case, for backward compatibility, the INSTANCE field and the builder class is not searched, so the instance will be always created with its parameterless constructor. (This behavior will possibly change in 2.4.) The () can't be omitted for nested expressions.

        • The classes and methods that the expression meant to access must be all public.

        Parameters:
        name - the name of the setting.
        value - the string that describes the new value of the setting.
        Throws:
        Configurable.UnknownSettingException - if the name is wrong.
        TemplateException - if the new value of the setting can't be set for any other reasons.
      • setStrictBeanModels

        public void setStrictBeanModels​(boolean strict)
      • getSetting

        public String getSetting​(String key)
        Deprecated.
        It's not possible in general to convert setting values to string, and thus it's impossible to ensure that setSetting(String, String) will work with the returned value correctly.
        Returns the textual representation of a setting.
        Parameters:
        key - the setting key. Can be any of standard XXX_KEY constants, or a custom key.
      • getSettings

        public Map getSettings()
        Deprecated.
        This method was always defective, and certainly it always will be. Don't use it. (Simply, it's hardly possible in general to convert setting values to text in a way that ensures that setSettings(Properties) will work with them correctly.)
        This meant to return the String-to-String Map of the settings. So it actually should return a Properties object, but it doesn't by mistake. The returned Map is read-only, but it will reflect the further configuration changes (aliasing effect).
      • getEnvironment

        protected Environment getEnvironment()
      • unknownSettingException

        protected TemplateException unknownSettingException​(String name)
        Creates the exception that should be thrown when a setting name isn't recognized.
      • getCorrectedNameForUnknownSetting

        protected String getCorrectedNameForUnknownSetting​(String name)
        Parameters:
        name - The wrong name
        Returns:
        The corrected name, or null if there's no known correction
        Since:
        2.3.21
      • setSettings

        public void setSettings​(Properties props)
                         throws TemplateException
        Set the settings stored in a Properties object.
        Throws:
        TemplateException - if the Properties object contains invalid keys, or invalid setting values, or any other error occurs while changing the settings.
      • setSettings

        public void setSettings​(InputStream propsIn)
                         throws TemplateException,
                                IOException
        Reads a setting list (key and element pairs) from the input stream. The stream has to follow the usual .properties format.
        Throws:
        TemplateException - if the stream contains invalid keys, or invalid setting values, or any other error occurs while changing the settings.
        IOException - if an error occurred when reading from the input stream.
      • setCustomAttribute

        public void setCustomAttribute​(String name,
                                       Object value)
        Sets a named custom attribute for this configurable.
        Parameters:
        name - the name of the custom attribute
        value - the value of the custom attribute. You can set the value to null, however note that there is a semantic difference between an attribute set to null and an attribute that is not present, see removeCustomAttribute(String).
      • getCustomAttributeNames

        public String[] getCustomAttributeNames()
        Returns an array with names of all custom attributes defined directly on this configurable. (That is, it doesn't contain the names of custom attributes defined indirectly on its parent configurables.) The returned array is never null, but can be zero-length. The order of elements in the returned array is not defined and can change between invocations.
      • removeCustomAttribute

        public void removeCustomAttribute​(String name)
        Removes a named custom attribute for this configurable. Note that this is different than setting the custom attribute value to null. If you set the value to null, getCustomAttribute(String) will return null, while if you remove the attribute, it will return the value of the attribute in the parent configurable (if there is a parent configurable, that is).
        Parameters:
        name - the name of the custom attribute
      • getCustomAttribute

        public Object getCustomAttribute​(String name)
        Retrieves a named custom attribute for this configurable. If the attribute is not present in the configurable, and the configurable has a parent, then the parent is looked up as well.
        Parameters:
        name - the name of the custom attribute
        Returns:
        the value of the custom attribute. Note that if the custom attribute was created with <#ftl attributes={...}>, then this value is already unwrapped (i.e. it's a String, or a List, or a Map, ...etc., not a FreeMarker specific class).