Package org.apache.velocity.runtime
Interface RuntimeConstants
- All Known Implementing Classes:
Runtime,RuntimeInstance,RuntimeSingleton,Velocity,VelocityEngine
public interface RuntimeConstants
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: RuntimeConstants.java 806601 2009-08-21 15:30:38Z nbubna $
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringInitial counter value in #foreach directives.static final StringCounter reference name in #foreach directives.static final StringDeprecated.Use LogChute.DEBUG_PREFIX insteadstatic final StringDefault Runtime properties.static final StringDefault Runtime properties.static final StringMaximum recursion depth allowed for the #define directive.static final StringIndicates if toString() should be called during #if condition evaluation just to ensure it does not return null.static final StringDefault Encoding is ISO-8859-1.static final StringDeprecated.Use LogChute.ERROR_PREFIX insteadstatic final StringEnding tag for error messages triggered by passing a parameter not allowed in the #include directive.static final StringStarting tag for error messages triggered by passing a parameter not allowed in the #include directive.static final Stringclass to use for local context with #evaluate()static final StringTheeventhandler.include.classproperty specifies a list of theIncludeEventHandlerimplementations to use.static final StringTheeventhandler.invalidreferences.classproperty specifies a list of theInvalidReferenceEventHandlerimplementations to use.static final StringTheeventhandler.methodexception.classproperty specifies a list of theMethodExceptionEventHandlerimplementations to use.static final StringTheeventhandler.nullset.classproperty specifies a list of theNullSetEventHandlerimplementations to use.static final StringTheeventhandler.referenceinsertion.classproperty specifies a list of theReferenceInsertionEventHandlerimplementations to use.static final StringThe public handle for turning the caching on in the FileResourceLoader.static final StringThe public handle for setting a path in the FileResourceLoader.static final StringIterator.hasNext() reference name in #foreach directives.static final StringDeprecated.Use LogChute.INFO_PREFIX insteadstatic final StringThe character encoding for the templates.static final StringSwitch for the interpolation facility for string literals.static final StringA comma separated list of classes to restrict access to in the SecureIntrospector.static final StringA comma separated list of packages to restrict access to in the SecureIntrospector.static final StringMaximum allowed number of loops.static final intThe default number of parser instances to create.static final StringEncoding for the output stream.static final StringMaximum recursion depth allowed for the #parse directive.static final StringTheparser.pool.classproperty specifies the name of theSimplePoolimplementation to use.static final Stringstatic final StringUsed to suppress various scope control objects.static final StringKey used to retrieve the names of the resource loaders to be used.static final StringTheresource.manager.cache.classproperty specifies the name of theResourceCacheimplementation to use.static final Stringstatic final StringTheresource.manager.cache.sizeproperty specifies the cache upper bound (if relevant).static final Stringcontrols if the finding of a resource is logged.static final StringLocation of the velocity log file.static final StringDeprecated.This appears to have always been meaningless.static final StringDeprecated.This appears to have always been meaningless.static final Stringexternally provided logger.static final Stringclass of log system to use.static final StringLogging of invalid references.static final StringDeprecated.The functionality this controlled is confusing and no longer necessary.static final StringProperties referenced in the template are required to exist the objectstatic final StringIndicates we are going to use modifed escape behavior in strict modestatic final Stringif set to true then allows #set to accept null values in the right hand side.static final StringWhether to throw an exception or just skip bad iterables.static final StringSwitch for ignoring nulls in math equations vs throwing exceptions.static final StringDeprecated.Use LogChute.TRACE_PREFIX insteadstatic final Stringkey name for uberspector.static final StringDeprecated.This will be removed in a future versionstatic final Stringif true, throw an exception for wrong number of argumentsstatic final StringDefines name of the reference that can be used to get the AST block passed to block macro calls.static final Stringswitch for local context in VM : default false.static final StringName of local Velocimacro library template.static final Stringswitch for autoloading library-sourced VMs (for development).static final StringDefault Velocimacro library template.static final StringSpecify the maximum depth for macro callsstatic final StringSwitch for VM blather : default true.static final Stringboolean (true/false) default true : allow inline (in-template) macro definitions.static final Stringboolean (true/false) default false : allow inline (in-template) macro definitions to replace existing.static final StringSwitch for forcing inline macros to be local : default false.static final StringDeprecated.Use LogChute.WARN_PREFIX instead
-
Field Details
-
RUNTIME_LOG
Location of the velocity log file.- See Also:
-
RUNTIME_LOG_LOGSYSTEM
externally provided logger.- See Also:
-
RUNTIME_LOG_LOGSYSTEM_CLASS
class of log system to use.- See Also:
-
RUNTIME_REFERENCES_STRICT
Properties referenced in the template are required to exist the object- See Also:
-
RUNTIME_REFERENCES_STRICT_ESCAPE
Indicates we are going to use modifed escape behavior in strict mode- See Also:
-
RUNTIME_LOG_ERROR_STACKTRACE
Deprecated.This appears to have always been meaningless.- See Also:
-
RUNTIME_LOG_WARN_STACKTRACE
Deprecated.The functionality this controlled is confusing and no longer necessary.- See Also:
-
RUNTIME_LOG_INFO_STACKTRACE
Deprecated.This appears to have always been meaningless.- See Also:
-
RUNTIME_LOG_REFERENCE_LOG_INVALID
Logging of invalid references.- See Also:
-
TRACE_PREFIX
Deprecated.Use LogChute.TRACE_PREFIX instead- See Also:
-
DEBUG_PREFIX
Deprecated.Use LogChute.DEBUG_PREFIX instead- See Also:
-
INFO_PREFIX
Deprecated.Use LogChute.INFO_PREFIX instead- See Also:
-
WARN_PREFIX
Deprecated.Use LogChute.WARN_PREFIX instead- See Also:
-
ERROR_PREFIX
Deprecated.Use LogChute.ERROR_PREFIX instead- See Also:
-
UNKNOWN_PREFIX
Deprecated.This will be removed in a future version- See Also:
-
COUNTER_NAME
Counter reference name in #foreach directives.- See Also:
-
HAS_NEXT_NAME
Iterator.hasNext() reference name in #foreach directives.- Since:
- 1.6
- See Also:
-
COUNTER_INITIAL_VALUE
Initial counter value in #foreach directives.- See Also:
-
MAX_NUMBER_LOOPS
Maximum allowed number of loops.- See Also:
-
SKIP_INVALID_ITERATOR
Whether to throw an exception or just skip bad iterables. Default is true.- Since:
- 1.6
- See Also:
-
SET_NULL_ALLOWED
if set to true then allows #set to accept null values in the right hand side.- See Also:
-
DIRECTIVE_IF_TOSTRING_NULLCHECK
Indicates if toString() should be called during #if condition evaluation just to ensure it does not return null. Check is unnecessary if all toString() implementations are known to have non-null return values. Disabling the check (like Velocity 1.5 did) will can boost performance since toString() may be a complex operation on large objects.- Since:
- 1.6
- See Also:
-
ERRORMSG_START
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
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
Maximum recursion depth allowed for the #parse directive.- See Also:
-
DEFINE_DIRECTIVE_MAXDEPTH
Maximum recursion depth allowed for the #define directive.- See Also:
-
EVALUATE_CONTEXT_CLASS
class to use for local context with #evaluate()- Since:
- 1.6
- See Also:
-
PROVIDE_SCOPE_CONTROL
Used to suppress various scope control objects.- Since:
- 1.7
- See Also:
-
RESOURCE_MANAGER_CLASS
- See Also:
-
RESOURCE_MANAGER_CACHE_CLASS
Theresource.manager.cache.classproperty specifies the name of theResourceCacheimplementation to use.- See Also:
-
RESOURCE_MANAGER_DEFAULTCACHE_SIZE
Theresource.manager.cache.sizeproperty specifies the cache upper bound (if relevant).- See Also:
-
RESOURCE_MANAGER_LOGWHENFOUND
controls if the finding of a resource is logged.- See Also:
-
RESOURCE_LOADER
Key used to retrieve the names of the resource loaders to be used. In a properties file they may appear as the following:resource.loader = file,classpath
- See Also:
-
FILE_RESOURCE_LOADER_PATH
The public handle for setting a path in the FileResourceLoader.- See Also:
-
FILE_RESOURCE_LOADER_CACHE
The public handle for turning the caching on in the FileResourceLoader.- See Also:
-
EVENTHANDLER_REFERENCEINSERTION
Theeventhandler.referenceinsertion.classproperty specifies a list of theReferenceInsertionEventHandlerimplementations to use.- See Also:
-
EVENTHANDLER_NULLSET
Theeventhandler.nullset.classproperty specifies a list of theNullSetEventHandlerimplementations to use.- See Also:
-
EVENTHANDLER_METHODEXCEPTION
Theeventhandler.methodexception.classproperty specifies a list of theMethodExceptionEventHandlerimplementations to use.- See Also:
-
EVENTHANDLER_INCLUDE
Theeventhandler.include.classproperty specifies a list of theIncludeEventHandlerimplementations to use.- See Also:
-
EVENTHANDLER_INVALIDREFERENCES
Theeventhandler.invalidreferences.classproperty specifies a list of theInvalidReferenceEventHandlerimplementations to use.- See Also:
-
VM_LIBRARY
Name of local Velocimacro library template.- See Also:
-
VM_LIBRARY_DEFAULT
Default Velocimacro library template.- See Also:
-
VM_LIBRARY_AUTORELOAD
switch for autoloading library-sourced VMs (for development).- See Also:
-
VM_PERM_ALLOW_INLINE
boolean (true/false) default true : allow inline (in-template) macro definitions.- See Also:
-
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
Switch for forcing inline macros to be local : default false.- See Also:
-
VM_MESSAGES_ON
Switch for VM blather : default true.- See Also:
-
VM_CONTEXT_LOCALSCOPE
switch for local context in VM : default false.- See Also:
-
VM_ARGUMENTS_STRICT
if true, throw an exception for wrong number of arguments- See Also:
-
VM_MAX_DEPTH
Specify the maximum depth for macro calls- Since:
- 1.6
- See Also:
-
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:
-
INTERPOLATE_STRINGLITERALS
Switch for the interpolation facility for string literals.- See Also:
-
INPUT_ENCODING
The character encoding for the templates. Used by the parser in processing the input streams.- See Also:
-
OUTPUT_ENCODING
Encoding for the output stream. Currently used by Anakia and VelocityServlet- See Also:
-
ENCODING_DEFAULT
Default Encoding is ISO-8859-1.- See Also:
-
UBERSPECT_CLASSNAME
key name for uberspector. Multiple classnames can be specified,in which case uberspectors will be chained.- See Also:
-
INTROSPECTOR_RESTRICT_PACKAGES
A comma separated list of packages to restrict access to in the SecureIntrospector.- See Also:
-
INTROSPECTOR_RESTRICT_CLASSES
A comma separated list of classes to restrict access to in the SecureIntrospector.- See Also:
-
STRICT_MATH
Switch for ignoring nulls in math equations vs throwing exceptions.- See Also:
-
PARSER_POOL_CLASS
Theparser.pool.classproperty specifies the name of theSimplePoolimplementation to use.- See Also:
-
PARSER_POOL_SIZE
- See Also:
-
DEFAULT_RUNTIME_PROPERTIES
Default Runtime properties.- See Also:
-
DEFAULT_RUNTIME_DIRECTIVES
Default Runtime properties.- See Also:
-
NUMBER_OF_PARSERS
static final int NUMBER_OF_PARSERSThe default number of parser instances to create. Configurable via the parameter named by thePARSER_POOL_SIZEconstant.- See Also:
-