Package org.apache.velocity.runtime

Interface RuntimeConstants

All Superinterfaces:
DeprecatedRuntimeConstants
All Known Implementing Classes:
RuntimeInstance, RuntimeSingleton, Velocity, VelocityEngine
public interface RuntimeConstants extends DeprecatedRuntimeConstants
This class defines the keys that are used in the velocity.properties file so that they can be referenced as a constant within Java code.
Version:
$Id$
Author:
Jon S. Stevens, Geir Magnusson Jr., Jason van Zyl

  • Field Details

    • RUNTIME_LOG_INSTANCE

      static final String RUNTIME_LOG_INSTANCE
      externally provided logger.
      See Also:

    • RUNTIME_LOG_NAME

      static final String RUNTIME_LOG_NAME
      externally provided logger name.
      See Also:

    • RUNTIME_LOG_REFERENCE_LOG_INVALID

      static final String RUNTIME_LOG_REFERENCE_LOG_INVALID
      Logging of invalid references.
      See Also:

    • RUNTIME_LOG_METHOD_CALL_LOG_INVALID

      static final String RUNTIME_LOG_METHOD_CALL_LOG_INVALID
      Logging of invalid method calls.
      See Also:

    • RUNTIME_LOG_TRACK_LOCATION

      static final String RUNTIME_LOG_TRACK_LOCATION

      Whether to:

      • populate slf4j's MDC with location in template file
      • display VTL stack trace on errors
      Since:
      2.2
      See Also:

    • MAX_NUMBER_LOOPS

      static final String MAX_NUMBER_LOOPS
      Maximum allowed number of loops.
      See Also:

    • SKIP_INVALID_ITERATOR

      static final String SKIP_INVALID_ITERATOR
      Whether to throw an exception or just skip bad iterables. Default is true.
      Since:
      1.6
      See Also:

    • CHECK_EMPTY_OBJECTS

      static final String CHECK_EMPTY_OBJECTS
      An empty object (string, collection) or zero number is false.
      Since:
      2.0
      See Also:

    • ERRORMSG_START

      static final String ERRORMSG_START
      Deprecated.
      if/how errors are displayed is not the concern of the engine, which should throw in all cases
      Starting tag for error messages triggered by passing a parameter not allowed in the #include directive. Only string literals, and references are allowed.
      See Also:

    • ERRORMSG_END

      static final String ERRORMSG_END
      Deprecated.
      if/how errors are displayed is not the concern of the engine, which should throw in all cases
      Ending tag for error messages triggered by passing a parameter not allowed in the #include directive. Only string literals, and references are allowed.
      See Also:

    • PARSE_DIRECTIVE_MAXDEPTH

      static final String PARSE_DIRECTIVE_MAXDEPTH
      Maximum recursion depth allowed for the #parse directive.
      See Also:

    • DEFINE_DIRECTIVE_MAXDEPTH

      static final String DEFINE_DIRECTIVE_MAXDEPTH
      Maximum recursion depth allowed for the #define directive.
      See Also:

    • PROVIDE_SCOPE_CONTROL

      @Deprecated static final String PROVIDE_SCOPE_CONTROL
      Deprecated.
      use context.scope_control.<scope_name> = true/false
      Used to suppress various scope control objects (property suffix).
      Since:
      1.7
      See Also:

    • CONTEXT_SCOPE_CONTROL

      static final String CONTEXT_SCOPE_CONTROL
      Used to enable or disable a scope control (false by default): context.scope_control.<scope_name> = true/false where scope_name is one of: template, evaluate, foreach, macro, define or the name of a body macro.
      Since:
      2.1
      See Also:

    • CUSTOM_DIRECTIVES

      static final String CUSTOM_DIRECTIVES
      Vector of custom directives
      See Also:

    • RESOURCE_MANAGER_INSTANCE

      static final String RESOURCE_MANAGER_INSTANCE
      The resource.manager.instance property specifies an existing instance of a ResourceManager implementation to use
      See Also:

    • RESOURCE_MANAGER_CLASS

      static final String RESOURCE_MANAGER_CLASS
      The resource.manager.class property specifies the name of the ResourceManager implementation to use.
      See Also:

    • RESOURCE_MANAGER_CACHE_CLASS

      static final String RESOURCE_MANAGER_CACHE_CLASS
      The resource.manager.cache.class property specifies the name of the ResourceCache implementation to use.
      See Also:

    • RESOURCE_MANAGER_DEFAULTCACHE_SIZE

      static final String RESOURCE_MANAGER_DEFAULTCACHE_SIZE
      The resource.manager.cache.size property specifies the cache upper bound (if relevant).
      See Also:

    • RESOURCE_MANAGER_LOGWHENFOUND

      static final String RESOURCE_MANAGER_LOGWHENFOUND
      controls if the finding of a resource is logged.
      See Also:

    • RESOURCE_LOADERS

      static final String RESOURCE_LOADERS
      Key used to retrieve the names of the resource loaders to be used. In a properties file they may appear as the following:

      resource.loaders = file,classpath

      See Also:

    • RESOURCE_LOADER

      static final String RESOURCE_LOADER
      Key prefix for a specific resource loader properties

      resource.loader.file.path = ...

      See Also:

    • FILE_RESOURCE_LOADER_PATH

      static final String FILE_RESOURCE_LOADER_PATH
      The public handle for setting paths in the FileResourceLoader. (this constant is used by test cases only)
      See Also:

    • FILE_RESOURCE_LOADER_CACHE

      static final String FILE_RESOURCE_LOADER_CACHE
      The public handle for turning the caching on in the FileResourceLoader.
      See Also:

    • RESOURCE_LOADER_CLASS

      static final String RESOURCE_LOADER_CLASS
      Resource loader class property suffix
      See Also:

    • RESOURCE_LOADER_INSTANCE

      static final String RESOURCE_LOADER_INSTANCE
      Resource loader instance property suffix
      See Also:

    • RESOURCE_LOADER_CACHE

      static final String RESOURCE_LOADER_CACHE
      Resource loader cache property suffix
      See Also:

    • RESOURCE_LOADER_PATHS

      static final String RESOURCE_LOADER_PATHS
      File resource loader paths property suffix
      See Also:

    • RESOURCE_LOADER_CHECK_INTERVAL

      static final String RESOURCE_LOADER_CHECK_INTERVAL
      Resource loader modification check interval property suffix
      See Also:

    • DS_RESOURCE_LOADER_DATASOURCE_URL

      static final String DS_RESOURCE_LOADER_DATASOURCE_URL
      Datasource loader datasource url
      See Also:

    • DS_RESOURCE_LOADER_DATASOURCE

      @Deprecated static final String DS_RESOURCE_LOADER_DATASOURCE
      Deprecated.
      Use DS_RESOURCE_LOADER_DATASOURCE_URL instead.
      See Also:

    • DS_RESOURCE_LOADER_TABLE

      static final String DS_RESOURCE_LOADER_TABLE
      Datasource loader templates table
      See Also:

    • DS_RESOURCE_LOADER_KEY_COLUMN

      static final String DS_RESOURCE_LOADER_KEY_COLUMN
      Datasource loader template key column
      See Also:

    • DS_RESOURCE_LOADER_TEMPLATE_COLUMN

      static final String DS_RESOURCE_LOADER_TEMPLATE_COLUMN
      Datasource loader template content column
      See Also:

    • DS_RESOURCE_LOADER_TIMESTAMP_COLUMN

      static final String DS_RESOURCE_LOADER_TIMESTAMP_COLUMN
      Datasource loader template timestamp column
      See Also:

    • DS_RESOURCE_LOADER_STMT_POOL_MAX_SIZE

      static final String DS_RESOURCE_LOADER_STMT_POOL_MAX_SIZE
      Datasource loader statements pool max size
      See Also:

    • INPUT_ENCODING

      static final String INPUT_ENCODING
      The default character encoding for the templates. Used by the parser in processing the input streams.
      See Also:

    • ENCODING_DEFAULT

      static final String ENCODING_DEFAULT
      Default Encoding is UTF-8.
      See Also:

    • EVENTHANDLER_REFERENCEINSERTION

      static final String EVENTHANDLER_REFERENCEINSERTION
      The event_handler.reference_insertion.class property specifies a list of the ReferenceInsertionEventHandler implementations to use.
      See Also:

    • EVENTHANDLER_METHODEXCEPTION

      static final String EVENTHANDLER_METHODEXCEPTION
      The event_handler.method_exception.class property specifies a list of the MethodExceptionEventHandler implementations to use.
      See Also:

    • EVENTHANDLER_INCLUDE

      static final String EVENTHANDLER_INCLUDE
      The event_handler.include.class property specifies a list of the IncludeEventHandler implementations to use.
      See Also:

    • EVENTHANDLER_INVALIDREFERENCES

      static final String EVENTHANDLER_INVALIDREFERENCES
      The event_handler.invalid_references.class property specifies a list of the InvalidReferenceEventHandler implementations to use.
      See Also:

    • EVENTHANDLER_INVALIDREFERENCES_QUIET

      static final String EVENTHANDLER_INVALIDREFERENCES_QUIET
      The event_handler.invalid_references.quiet property specifies if invalid quiet references (as in $!foo) trigger events (defaults to false). InvalidReferenceEventHandler implementations to use.
      Since:
      2.2
      See Also:

    • EVENTHANDLER_INVALIDREFERENCES_NULL

      static final String EVENTHANDLER_INVALIDREFERENCES_NULL
      The event_handler.invalid_references.null property specifies if invalid null references (aka the value is present in the context or parent object but is null or a method returned null) trigger invalid reference events (defaults to false). InvalidReferenceEventHandler implementations to use.
      Since:
      2.2
      See Also:

    • EVENTHANDLER_INVALIDREFERENCES_TESTED

      static final String EVENTHANDLER_INVALIDREFERENCES_TESTED
      The event_handler.invalid_references.tested property specifies if invalid tested references (as in #if($foo) ) trigger invalid reference events (defaults to false). InvalidReferenceEventHandler implementations to use.
      Since:
      2.2
      See Also:

    • VM_LIBRARY

      static final String VM_LIBRARY
      Filename of local Velocimacro library template.
      See Also:

    • VM_LIBRARY_DEFAULT

      static final String VM_LIBRARY_DEFAULT
      Default Velocimacro library template.
      See Also:

    • VM_LIBRARY_AUTORELOAD

      static final String VM_LIBRARY_AUTORELOAD
      switch for autoloading library-sourced VMs (for development).
      See Also:

    • VM_PERM_ALLOW_INLINE

      static final String VM_PERM_ALLOW_INLINE
      boolean (true/false) default true: allow inline (in-template) macro definitions.
      See Also:

    • VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL

      static final String VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL
      boolean (true/false) default false: allow inline (in-template) macro definitions to replace existing.
      See Also:

    • VM_PERM_INLINE_LOCAL

      static final String VM_PERM_INLINE_LOCAL
      Switch for forcing inline macros to be local: default false.
      See Also:

    • VM_ARGUMENTS_STRICT

      static final String VM_ARGUMENTS_STRICT
      if true, throw an exception for wrong number of arguments
      See Also:

    • VM_ENABLE_BC_MODE

      static final String VM_ENABLE_BC_MODE
      This flag enable the 1.7 backward compatible mode for velocimacros (defaults to false):
      • preserve argument literals: when displaying null or invalid non-quiet references, use the argument literal reference instead of the one in the macro block. Defaults to false.
      • use global values for missing arguments: when calling a macro with fewer arguments than declared, if those arguments don't have an explicit default value in the macro definition, default values will be looked for in the global context
      Since:
      2.2
      See Also:

    • VM_MAX_DEPTH

      static final String VM_MAX_DEPTH
      Specify the maximum depth for macro calls
      Since:
      1.6
      See Also:

    • VM_BODY_REFERENCE

      static final String VM_BODY_REFERENCE
      Defines name of the reference that can be used to get the AST block passed to block macro calls.
      Since:
      1.7
      See Also:

    • VM_MESSAGES_ON

      @Deprecated static final String VM_MESSAGES_ON
      Deprecated.
      since 2.1

      Switch for VM blather: default true. Unused since 2.0.

      See Also:

    • RUNTIME_REFERENCES_STRICT

      static final String RUNTIME_REFERENCES_STRICT
      Properties referenced in the template are required to exist the object
      See Also:

    • RUNTIME_REFERENCES_STRICT_ESCAPE

      static final String RUNTIME_REFERENCES_STRICT_ESCAPE
      Indicates we are going to use modified escape behavior in strict mode
      See Also:

    • UBERSPECT_CLASSNAME

      static final String UBERSPECT_CLASSNAME
      key name for uberspector. Multiple classnames can be specified,in which case uberspectors will be chained.
      See Also:

    • INTROSPECTOR_RESTRICT_PACKAGES

      static final String INTROSPECTOR_RESTRICT_PACKAGES
      A comma separated list of packages to restrict access to in the SecureIntrospector.
      See Also:

    • INTROSPECTOR_RESTRICT_CLASSES

      static final String INTROSPECTOR_RESTRICT_CLASSES
      A comma separated list of classes to restrict access to in the SecureIntrospector.
      See Also:

    • INTROSPECTOR_RESTRICT_METHODS

      static final String INTROSPECTOR_RESTRICT_METHODS
      A comma separated list of methods to restrict access to in the SecureIntrospector. Each entry has the form fully.qualified.ClassName.methodName and applies to the named class and all its subclasses. Method overloads cannot be distinguished; all overloads sharing the method name are blocked.
      Since:
      2.5
      See Also:

    • CONVERSION_HANDLER_CLASS

      static final String CONVERSION_HANDLER_CLASS
      key for Conversion Manager class
      See Also:

    • CONVERSION_HANDLER_INSTANCE

      static final String CONVERSION_HANDLER_INSTANCE
      key for Conversion Manager instance
      See Also:

    • PARSER_CLASS

      static final String PARSER_CLASS
      Property specifying the parser class to use
      Since:
      2.2
      See Also:

    • DEFAULT_PARSER_CLASS

      static final String DEFAULT_PARSER_CLASS
      Default parser class
      Since:
      2.2
      See Also:

    • PARSER_POOL_CLASS

      static final String PARSER_POOL_CLASS
      The parser.pool.class property specifies the name of the SimplePool implementation to use.
      See Also:

    • PARSER_POOL_SIZE

      static final String PARSER_POOL_SIZE
      See Also:

    • PARSER_HYPHEN_ALLOWED

      static final String PARSER_HYPHEN_ALLOWED
      Allow hyphen in identifiers (backward compatibility option)
      Since:
      2.1
      See Also:

    • RUNTIME_STRING_INTERNING

      static final String RUNTIME_STRING_INTERNING
      Whether to use string interning.
      See Also:

    • INTERPOLATE_STRINGLITERALS

      static final String INTERPOLATE_STRINGLITERALS
      Switch for the interpolation facility for string literals.
      See Also:

    • IMMUTABLE_RANGES

      static final String IMMUTABLE_RANGES
      Switch for the immutability of integer ranges.
      See Also:

    • RUNTIME_DEPRECATION_WARN

      static final String RUNTIME_DEPRECATION_WARN
      Whether to warn about deprecated VTL syntax constructs (off by default, will be turned on in the next 2.x release).
      See Also:

    • STRICT_MATH

      static final String STRICT_MATH
      Switch for ignoring nulls in math equations vs throwing exceptions.
      See Also:

    • CONTEXT_AUTOREFERENCE_KEY

      static final String CONTEXT_AUTOREFERENCE_KEY
      Key upon which a context should be accessible within itself
      See Also:

    • SPACE_GOBBLING

      static final String SPACE_GOBBLING
      Space gobbling mode
      Since:
      2.0
      See Also:

    • DEFAULT_RUNTIME_PROPERTIES

      static final String DEFAULT_RUNTIME_PROPERTIES
      Default Runtime properties.
      See Also:

    • DEFAULT_RUNTIME_DIRECTIVES

      static final String DEFAULT_RUNTIME_DIRECTIVES
      Default Runtime properties.
      See Also:

    • DEFAULT_RUNTIME_LOG_NAME

      static final String DEFAULT_RUNTIME_LOG_NAME
      externally provided logger name.
      See Also:

    • RESOURCE_LOADER_IDENTIFIER

      static final String RESOURCE_LOADER_IDENTIFIER
      token used to identify the loader internally.
      See Also:

    • NUMBER_OF_PARSERS

      static final int NUMBER_OF_PARSERS
      The default number of parser instances to create. Configurable via the parameter named by the PARSER_POOL_SIZE constant.
      See Also: