freemarker.engine
Class PropertyConstants

java.lang.Object
  freemarker.engine.PropertyConstants

public final class PropertyConstants
extends java.lang.Object

Constants to be supplied to FMEngine to configure the engine's runtime behaviour. These are supplied using the setProperty() method or the init(Properties) methods of the FMEngine class.

Many of the property values are supplied as class names to be loaded using reflection.

Class names may be given as:

 package.name.classname
 

Static fields may be addressed within a class as:

 package.name.classname.field
 

or:

 package.name.classname#field
 

When reflection is performed, it is handled the following way:

• First of all, the name of the class is determined. There may be a field name as the last part of the name
• If the name consists only of a class name,
  • Try and call a public no-argument constructor
  • Otherwise, look for a public, static, no-argument method that returns a singleton object
  • Otherwise, look for a public, static, final field that contains a singleton object
  Singleton method and field names are determined using the TEMPLATE_ENGINE_INSTANCE_METHODS and TEMPLATE_ENGINE_INSTANCE_FIELDS properties described below.
• Otherwise, look for a public, static, final field with the given name that contains a singleton object
• Otherwise, look for a public, static, no-argument method that returns a singleton object

Since:

1.9

Version:

$Id: PropertyConstants.java 1172 2013-04-21 10:00:22Z run2000 $

Author:

Nicholas Cull

Field Summary

static java.lang.String	TEMPLATE_CACHE_STRATEGY The class name of the CachingStrategyFactory for caching items.
static java.lang.String	TEMPLATE_CACHE_SUFFIX The filename suffix for items to be stored in the cache.
static java.lang.String	TEMPLATE_CACHE_UPDATE_MAXAGE Determines when items in the cache should be expired, as an integer value.
static java.lang.String	TEMPLATE_CACHE_UPDATE_PERIOD Determines how often templates in the cache should be checked for changes, as an integer number of seconds.
static java.lang.String	TEMPLATE_ENCODING The character encoding to be used when reading templates from the file system.
static java.lang.String	TEMPLATE_ENGINE_INSTANCE_FIELDS A list of field names for looking up a singleton field of a class.
static java.lang.String	TEMPLATE_ENGINE_INSTANCE_METHODS A list of method names for looking up a singleton method of a class.
static java.lang.String	TEMPLATE_PATH The fully-qualified path to a directory containing template files.
static java.lang.String	TEMPLATE_RETRIEVER The class name of the CacheRetrieverFactory for retrieving items to be cached.
static java.lang.String	TEMPLATE_RUNTIME_ESCAPE The class name or names of the TemplateTransformModel or TemplateTransformModel2 objects used whenever a variable is written to the writer.
static java.lang.String	TEMPLATE_RUNTIME_GLOBAL_FILTER The class name or names of the TemplateTransformModel or TemplateTransformModel2 that filters all output from the template.
static java.lang.String	TEMPLATE_RUNTIME_HANDLER The class name of the TemplateRuntimeHandler used whenever an error is reported by the runtime engine.
static java.lang.String	TEMPLATE_TYPE_DEFAULT The default template type.

Method Summary

static java.util.Properties

getDefaultProperties() Retrieve a default set of properties sufficient to bootstrap the FMEngine object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEMPLATE_PATH

public static final java.lang.String TEMPLATE_PATH

The fully-qualified path to a directory containing template files.

See Also:

Constant Field Values

TEMPLATE_ENCODING

public static final java.lang.String TEMPLATE_ENCODING

The character encoding to be used when reading templates from the file system.

See Also:

Constant Field Values

TEMPLATE_TYPE_DEFAULT

public static final java.lang.String TEMPLATE_TYPE_DEFAULT

The default template type. The names are registered with the TemplateRegistry.

See Also:

Constant Field Values

TEMPLATE_RETRIEVER

public static final java.lang.String TEMPLATE_RETRIEVER

The class name of the CacheRetrieverFactory for retrieving items to be cached.

See Also:

CacheRetrieverFactory, Constant Field Values

TEMPLATE_CACHE_STRATEGY

public static final java.lang.String TEMPLATE_CACHE_STRATEGY

The class name of the CachingStrategyFactory for caching items.

See Also:

CachingStrategyFactory, Constant Field Values

TEMPLATE_CACHE_UPDATE_MAXAGE

public static final java.lang.String TEMPLATE_CACHE_UPDATE_MAXAGE

Determines when items in the cache should be expired, as an integer value.

See Also:

Constant Field Values

TEMPLATE_CACHE_UPDATE_PERIOD

public static final java.lang.String TEMPLATE_CACHE_UPDATE_PERIOD

Determines how often templates in the cache should be checked for changes, as an integer number of seconds.

See Also:

Constant Field Values

TEMPLATE_CACHE_SUFFIX

public static final java.lang.String TEMPLATE_CACHE_SUFFIX

The filename suffix for items to be stored in the cache. Only items with the given suffix will be stored.

See Also:

Constant Field Values

TEMPLATE_RUNTIME_ESCAPE

public static final java.lang.String TEMPLATE_RUNTIME_ESCAPE

The class name or names of the TemplateTransformModel or TemplateTransformModel2 objects used whenever a variable is written to the writer. If multiple classes are specified, the names are separated by semicolons, colons, or spaces.

See Also:

TemplateTransformModel, TemplateTransformModel2, Constant Field Values

TEMPLATE_RUNTIME_GLOBAL_FILTER

public static final java.lang.String TEMPLATE_RUNTIME_GLOBAL_FILTER

The class name or names of the TemplateTransformModel or TemplateTransformModel2 that filters all output from the template. If multiple classes are specified, the names are separated by semicolons, colons, or spaces.

See Also:

TemplateTransformModel, TemplateTransformModel2, Constant Field Values

TEMPLATE_RUNTIME_HANDLER

public static final java.lang.String TEMPLATE_RUNTIME_HANDLER

The class name of the TemplateRuntimeHandler used whenever an error is reported by the runtime engine.

See Also:

TemplateRuntimeHandler, Constant Field Values

TEMPLATE_ENGINE_INSTANCE_METHODS

public static final java.lang.String TEMPLATE_ENGINE_INSTANCE_METHODS

A list of method names for looking up a singleton method of a class. The names are separated by semicolons, colons, or spaces.

See Also:

Constant Field Values

TEMPLATE_ENGINE_INSTANCE_FIELDS

public static final java.lang.String TEMPLATE_ENGINE_INSTANCE_FIELDS

A list of field names for looking up a singleton field of a class. The names are separated by semicolons, colons, or spaces.

See Also:

Constant Field Values

Method Detail

getDefaultProperties

public static java.util.Properties getDefaultProperties()

Retrieve a default set of properties sufficient to bootstrap the FMEngine object. This is the default set used when no other properties are supplied.

Returns:

a Properties object containing a default set of properties sufficient to bootstrap the FMEngine object