blob: df01e0e173f32b90af1591a2e99f04f28e4e5926 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_191) on Sat Feb 27 13:52:03 CET 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Velocity (Apache Velocity 2.3 API)</title>
<meta name="date" content="2021-02-27">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Velocity (Apache Velocity 2.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":10,"i13":9,"i14":10,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Velocity.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/velocity/app/FieldMethodizer.html" title="class in org.apache.velocity.app"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/velocity/app/VelocityEngine.html" title="class in org.apache.velocity.app"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/velocity/app/Velocity.html" target="_top">Frames</a></li>
<li><a href="Velocity.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.velocity.app</div>
<h2 title="Class Velocity" class="title">Class Velocity</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.velocity.app.Velocity</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html" title="interface in org.apache.velocity.runtime">DeprecatedRuntimeConstants</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html" title="interface in org.apache.velocity.runtime">RuntimeConstants</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Velocity</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html" title="interface in org.apache.velocity.runtime">RuntimeConstants</a></pre>
<div class="block">This class provides services to the application
developer, such as:
<ul>
<li> Simple Velocity Runtime engine initialization methods.
<li> Functions to apply the template engine to streams and strings
to allow embedding and dynamic template generation.
<li> Methods to access Velocimacros directly.
</ul>
<br><br>
While the most common way to use Velocity is via templates, as
Velocity is a general-purpose template engine, there are other
uses that Velocity is well suited for, such as processing dynamically
created templates, or processing content streams.
<br><br>
The methods herein were developed to allow easy access to the Velocity
facilities without direct spelunking of the internals. If there is
something you feel is necessary to add here, please, send a patch.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id$</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>, <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.velocity.runtime.RuntimeConstants">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.velocity.runtime.<a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html" title="interface in org.apache.velocity.runtime">RuntimeConstants</a></h3>
<code><a href="../../../../org/apache/velocity/runtime/RuntimeConstants.SpaceGobbling.html" title="enum in org.apache.velocity.runtime">RuntimeConstants.SpaceGobbling</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.runtime.RuntimeConstants">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.velocity.runtime.<a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html" title="interface in org.apache.velocity.runtime">RuntimeConstants</a></h3>
<code><a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#CHECK_EMPTY_OBJECTS">CHECK_EMPTY_OBJECTS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#CONTEXT_AUTOREFERENCE_KEY">CONTEXT_AUTOREFERENCE_KEY</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#CONTEXT_SCOPE_CONTROL">CONTEXT_SCOPE_CONTROL</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#CONVERSION_HANDLER_CLASS">CONVERSION_HANDLER_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#CONVERSION_HANDLER_INSTANCE">CONVERSION_HANDLER_INSTANCE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#CUSTOM_DIRECTIVES">CUSTOM_DIRECTIVES</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DEFAULT_PARSER_CLASS">DEFAULT_PARSER_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DEFAULT_RUNTIME_DIRECTIVES">DEFAULT_RUNTIME_DIRECTIVES</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DEFAULT_RUNTIME_LOG_NAME">DEFAULT_RUNTIME_LOG_NAME</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DEFAULT_RUNTIME_PROPERTIES">DEFAULT_RUNTIME_PROPERTIES</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DEFINE_DIRECTIVE_MAXDEPTH">DEFINE_DIRECTIVE_MAXDEPTH</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DS_RESOURCE_LOADER_DATASOURCE">DS_RESOURCE_LOADER_DATASOURCE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DS_RESOURCE_LOADER_KEY_COLUMN">DS_RESOURCE_LOADER_KEY_COLUMN</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DS_RESOURCE_LOADER_TABLE">DS_RESOURCE_LOADER_TABLE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DS_RESOURCE_LOADER_TEMPLATE_COLUMN">DS_RESOURCE_LOADER_TEMPLATE_COLUMN</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#DS_RESOURCE_LOADER_TIMESTAMP_COLUMN">DS_RESOURCE_LOADER_TIMESTAMP_COLUMN</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#ENCODING_DEFAULT">ENCODING_DEFAULT</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#ERRORMSG_END">ERRORMSG_END</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#ERRORMSG_START">ERRORMSG_START</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_INCLUDE">EVENTHANDLER_INCLUDE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_INVALIDREFERENCES">EVENTHANDLER_INVALIDREFERENCES</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_INVALIDREFERENCES_NULL">EVENTHANDLER_INVALIDREFERENCES_NULL</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_INVALIDREFERENCES_QUIET">EVENTHANDLER_INVALIDREFERENCES_QUIET</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_INVALIDREFERENCES_TESTED">EVENTHANDLER_INVALIDREFERENCES_TESTED</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_METHODEXCEPTION">EVENTHANDLER_METHODEXCEPTION</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#EVENTHANDLER_REFERENCEINSERTION">EVENTHANDLER_REFERENCEINSERTION</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#FILE_RESOURCE_LOADER_CACHE">FILE_RESOURCE_LOADER_CACHE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#FILE_RESOURCE_LOADER_PATH">FILE_RESOURCE_LOADER_PATH</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#INPUT_ENCODING">INPUT_ENCODING</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#INTERPOLATE_STRINGLITERALS">INTERPOLATE_STRINGLITERALS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#INTROSPECTOR_RESTRICT_CLASSES">INTROSPECTOR_RESTRICT_CLASSES</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#INTROSPECTOR_RESTRICT_PACKAGES">INTROSPECTOR_RESTRICT_PACKAGES</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#MAX_NUMBER_LOOPS">MAX_NUMBER_LOOPS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#NUMBER_OF_PARSERS">NUMBER_OF_PARSERS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#PARSE_DIRECTIVE_MAXDEPTH">PARSE_DIRECTIVE_MAXDEPTH</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#PARSER_CLASS">PARSER_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#PARSER_HYPHEN_ALLOWED">PARSER_HYPHEN_ALLOWED</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#PARSER_POOL_CLASS">PARSER_POOL_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#PARSER_POOL_SIZE">PARSER_POOL_SIZE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#PROVIDE_SCOPE_CONTROL">PROVIDE_SCOPE_CONTROL</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER">RESOURCE_LOADER</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER_CACHE">RESOURCE_LOADER_CACHE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER_CHECK_INTERVAL">RESOURCE_LOADER_CHECK_INTERVAL</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER_CLASS">RESOURCE_LOADER_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER_IDENTIFIER">RESOURCE_LOADER_IDENTIFIER</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER_INSTANCE">RESOURCE_LOADER_INSTANCE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADER_PATHS">RESOURCE_LOADER_PATHS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_LOADERS">RESOURCE_LOADERS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_MANAGER_CACHE_CLASS">RESOURCE_MANAGER_CACHE_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_MANAGER_CLASS">RESOURCE_MANAGER_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_MANAGER_DEFAULTCACHE_SIZE">RESOURCE_MANAGER_DEFAULTCACHE_SIZE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_MANAGER_INSTANCE">RESOURCE_MANAGER_INSTANCE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RESOURCE_MANAGER_LOGWHENFOUND">RESOURCE_MANAGER_LOGWHENFOUND</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_LOG_INSTANCE">RUNTIME_LOG_INSTANCE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_LOG_METHOD_CALL_LOG_INVALID">RUNTIME_LOG_METHOD_CALL_LOG_INVALID</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_LOG_NAME">RUNTIME_LOG_NAME</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_LOG_REFERENCE_LOG_INVALID">RUNTIME_LOG_REFERENCE_LOG_INVALID</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_LOG_TRACK_LOCATION">RUNTIME_LOG_TRACK_LOCATION</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_REFERENCES_STRICT">RUNTIME_REFERENCES_STRICT</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_REFERENCES_STRICT_ESCAPE">RUNTIME_REFERENCES_STRICT_ESCAPE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#RUNTIME_STRING_INTERNING">RUNTIME_STRING_INTERNING</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#SKIP_INVALID_ITERATOR">SKIP_INVALID_ITERATOR</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#SPACE_GOBBLING">SPACE_GOBBLING</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#STRICT_MATH">STRICT_MATH</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#UBERSPECT_CLASSNAME">UBERSPECT_CLASSNAME</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_ARGUMENTS_STRICT">VM_ARGUMENTS_STRICT</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_BODY_REFERENCE">VM_BODY_REFERENCE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_ENABLE_BC_MODE">VM_ENABLE_BC_MODE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_LIBRARY">VM_LIBRARY</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_LIBRARY_AUTORELOAD">VM_LIBRARY_AUTORELOAD</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_LIBRARY_DEFAULT">VM_LIBRARY_DEFAULT</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_MAX_DEPTH">VM_MAX_DEPTH</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_MESSAGES_ON">VM_MESSAGES_ON</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_PERM_ALLOW_INLINE">VM_PERM_ALLOW_INLINE</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL">VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL</a>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_PERM_INLINE_LOCAL">VM_PERM_INLINE_LOCAL</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.runtime.DeprecatedRuntimeConstants">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.velocity.runtime.<a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html" title="interface in org.apache.velocity.runtime">DeprecatedRuntimeConstants</a></h3>
<code><a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_CHECK_EMPTY_OBJECTS">OLD_CHECK_EMPTY_OBJECTS</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_CONTEXT_AUTOREFERENCE_KEY">OLD_CONTEXT_AUTOREFERENCE_KEY</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_CONVERSION_HANDLER_CLASS">OLD_CONVERSION_HANDLER_CLASS</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_CUSTOM_DIRECTIVES">OLD_CUSTOM_DIRECTIVES</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_DEFINE_DIRECTIVE_MAXDEPTH">OLD_DEFINE_DIRECTIVE_MAXDEPTH</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_DS_RESOURCE_LOADER_DATASOURCE">OLD_DS_RESOURCE_LOADER_DATASOURCE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_DS_RESOURCE_LOADER_KEY_COLUMN">OLD_DS_RESOURCE_LOADER_KEY_COLUMN</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_DS_RESOURCE_LOADER_TEMPLATE_COLUMN">OLD_DS_RESOURCE_LOADER_TEMPLATE_COLUMN</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_DS_RESOURCE_LOADER_TIMESTAMP_COLUMN">OLD_DS_RESOURCE_LOADER_TIMESTAMP_COLUMN</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_ERRORMSG_END">OLD_ERRORMSG_END</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_ERRORMSG_START">OLD_ERRORMSG_START</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_EVENTHANDLER_INCLUDE">OLD_EVENTHANDLER_INCLUDE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_EVENTHANDLER_INVALIDREFERENCES">OLD_EVENTHANDLER_INVALIDREFERENCES</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_EVENTHANDLER_METHODEXCEPTION">OLD_EVENTHANDLER_METHODEXCEPTION</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_EVENTHANDLER_REFERENCEINSERTION">OLD_EVENTHANDLER_REFERENCEINSERTION</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_FILE_RESOURCE_LOADER_CACHE">OLD_FILE_RESOURCE_LOADER_CACHE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_FILE_RESOURCE_LOADER_PATH">OLD_FILE_RESOURCE_LOADER_PATH</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_INPUT_ENCODING">OLD_INPUT_ENCODING</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_INTERPOLATE_STRINGLITERALS">OLD_INTERPOLATE_STRINGLITERALS</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_MAX_NUMBER_LOOPS">OLD_MAX_NUMBER_LOOPS</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_PARSE_DIRECTIVE_MAXDEPTH">OLD_PARSE_DIRECTIVE_MAXDEPTH</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RESOURCE_LOADER_CHECK_INTERVAL">OLD_RESOURCE_LOADER_CHECK_INTERVAL</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RESOURCE_LOADERS">OLD_RESOURCE_LOADERS</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RESOURCE_MANAGER_DEFAULTCACHE_SIZE">OLD_RESOURCE_MANAGER_DEFAULTCACHE_SIZE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RESOURCE_MANAGER_LOGWHENFOUND">OLD_RESOURCE_MANAGER_LOGWHENFOUND</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RUNTIME_LOG_REFERENCE_LOG_INVALID">OLD_RUNTIME_LOG_REFERENCE_LOG_INVALID</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RUNTIME_REFERENCES_STRICT">OLD_RUNTIME_REFERENCES_STRICT</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_RUNTIME_REFERENCES_STRICT_ESCAPE">OLD_RUNTIME_REFERENCES_STRICT_ESCAPE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_SKIP_INVALID_ITERATOR">OLD_SKIP_INVALID_ITERATOR</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_SPACE_GOBBLING">OLD_SPACE_GOBBLING</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_STRICT_MATH">OLD_STRICT_MATH</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_UBERSPECT_CLASSNAME">OLD_UBERSPECT_CLASSNAME</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_BODY_REFERENCE">OLD_VM_BODY_REFERENCE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_ENABLE_BC_MODE">OLD_VM_ENABLE_BC_MODE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_LIBRARY">OLD_VM_LIBRARY</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_LIBRARY_DEFAULT">OLD_VM_LIBRARY_DEFAULT</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_MAX_DEPTH">OLD_VM_MAX_DEPTH</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_PERM_ALLOW_INLINE">OLD_VM_PERM_ALLOW_INLINE</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL">OLD_VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL</a>, <a href="../../../../org/apache/velocity/runtime/DeprecatedRuntimeConstants.html#OLD_VM_PERM_INLINE_LOCAL">OLD_VM_PERM_INLINE_LOCAL</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#Velocity--">Velocity</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#addProperty-java.lang.String-java.lang.Object-">addProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Add a Velocity Runtime property.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#clearProperty-java.lang.String-">clearProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</code>
<div class="block">Clear a Velocity Runtime property.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#evaluate-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-java.io.Reader-">evaluate</a></span>(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logTag,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;reader)</code>
<div class="block">Renders the input reader using the context into the output writer.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#evaluate-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-java.lang.String-">evaluate</a></span>(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logTag,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;instring)</code>
<div class="block">renders the input string using the context into the output writer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#getLog--">getLog</a></span>()</code>
<div class="block">Returns the current logger.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#getProperty-java.lang.String-">getProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</code>
<div class="block">Get a Velocity Runtime property.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#getTemplate-java.lang.String-">getTemplate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns a <code>Template</code> from the Velocity
resource management system.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#getTemplate-java.lang.String-java.lang.String-">getTemplate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding)</code>
<div class="block">Returns a <code>Template</code> from the Velocity
resource management system.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#init--">init</a></span>()</code>
<div class="block">initialize the Velocity runtime engine, using the default
properties of the Velocity distribution</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#init-java.util.Properties-">init</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;p)</code>
<div class="block">initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#init-java.lang.String-">init</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propsFilename)</code>
<div class="block">initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#invokeVelocimacro-java.lang.String-java.lang.String-java.lang.String:A-org.apache.velocity.context.Context-java.io.Writer-">invokeVelocimacro</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;vmName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logTag,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;params,
<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">Invokes a currently registered Velocimacro with the params provided
and places the rendered stream into the writer.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#loadDirective-java.lang.String-">loadDirective</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;directiveClass)</code>
<div class="block">Instantiates and loads the directive with some basic checks.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#mergeTemplate-java.lang.String-java.lang.String-org.apache.velocity.context.Context-java.io.Writer-">mergeTemplate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;templateName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding,
<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">Merges a template and puts the rendered stream into the writer</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#removeDirective-java.lang.String-">removeDirective</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Remove a directive.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#reset--">reset</a></span>()</code>
<div class="block">Resets the instance, so Velocity can be re-initialized again.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#resourceExists-java.lang.String-">resourceExists</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resourceName)</code>
<div class="block">Determines whether a resource is accessible via the
currently configured resource loaders.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#setApplicationAttribute-java.lang.Object-java.lang.Object-">setApplicationAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">
Set the an ApplicationAttribue, which is an Object
set by the application which is accessible from
any component of the system that gets a RuntimeServices.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#setProperties-java.util.Properties-">setProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;configuration)</code>
<div class="block">Set an entire configuration at once.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/app/Velocity.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Set a Velocity Runtime property.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Velocity--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Velocity</h4>
<pre>public&nbsp;Velocity()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public static&nbsp;void&nbsp;init()</pre>
<div class="block">initialize the Velocity runtime engine, using the default
properties of the Velocity distribution</div>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public static&nbsp;void&nbsp;reset()</pre>
<div class="block">Resets the instance, so Velocity can be re-initialized again.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a name="init-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public static&nbsp;void&nbsp;init(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propsFilename)</pre>
<div class="block">initialize the Velocity runtime engine, using default properties
plus the properties in the properties file passed in as the arg</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propsFilename</code> - file containing properties to use to initialize
the Velocity runtime</dd>
</dl>
</li>
</ul>
<a name="init-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public static&nbsp;void&nbsp;init(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;p)</pre>
<div class="block">initialize the Velocity runtime engine, using default properties
plus the properties in the passed in java.util.Properties object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - Properties object containing initialization properties</dd>
</dl>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public static&nbsp;void&nbsp;setProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Set a Velocity Runtime property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The property key.</dd>
<dd><code>value</code> - The property value.</dd>
</dl>
</li>
</ul>
<a name="addProperty-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public static&nbsp;void&nbsp;addProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Add a Velocity Runtime property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The property key.</dd>
<dd><code>value</code> - The property value.</dd>
</dl>
</li>
</ul>
<a name="clearProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearProperty</h4>
<pre>public static&nbsp;void&nbsp;clearProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">Clear a Velocity Runtime property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - of property to clear</dd>
</dl>
</li>
</ul>
<a name="setProperties-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>public static&nbsp;void&nbsp;setProperties(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;configuration)</pre>
<div class="block">Set an entire configuration at once.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - A configuration object.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">Get a Velocity Runtime property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - property to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>property value or null if the property
not currently set</dd>
</dl>
</li>
</ul>
<a name="evaluate-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>public static&nbsp;boolean&nbsp;evaluate(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logTag,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;instring)
throws <a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a>,
<a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a>,
<a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></pre>
<div class="block">renders the input string using the context into the output writer.
To be used when a template is dynamically constructed, or want to use
Velocity as a token replacer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - context to use in rendering input string</dd>
<dd><code>out</code> - Writer in which to render the output</dd>
<dd><code>logTag</code> - string to be used as the template name for log
messages in case of error</dd>
<dd><code>instring</code> - input string containing the VTL to be rendered</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if successful, false otherwise. If false, see
Velocity runtime log</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - The template could not be parsed.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a></code> - A method on a context object could not be invoked.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - A referenced resource could not be loaded.</dd>
</dl>
</li>
</ul>
<a name="evaluate-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-java.io.Reader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>public static&nbsp;boolean&nbsp;evaluate(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logTag,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;reader)
throws <a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a>,
<a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a>,
<a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></pre>
<div class="block">Renders the input reader using the context into the output writer.
To be used when a template is dynamically constructed, or want to
use Velocity as a token replacer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - context to use in rendering input string</dd>
<dd><code>writer</code> - Writer in which to render the output</dd>
<dd><code>logTag</code> - string to be used as the template name for log messages
in case of error</dd>
<dd><code>reader</code> - Reader containing the VTL to be rendered</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if successful, false otherwise. If false, see
Velocity runtime log</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - The template could not be parsed.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a></code> - A method on a context object could not be invoked.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - A referenced resource could not be loaded.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Velocity v1.1</dd>
</dl>
</li>
</ul>
<a name="invokeVelocimacro-java.lang.String-java.lang.String-java.lang.String:A-org.apache.velocity.context.Context-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invokeVelocimacro</h4>
<pre>public static&nbsp;boolean&nbsp;invokeVelocimacro(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;vmName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logTag,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;params,
<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</pre>
<div class="block">Invokes a currently registered Velocimacro with the params provided
and places the rendered stream into the writer.
<br>
Note : currently only accepts args to the VM if they are in the context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vmName</code> - name of Velocimacro to call</dd>
<dd><code>logTag</code> - string to be used for template name in case of error. if null,
the vmName will be used</dd>
<dd><code>params</code> - keys for args used to invoke Velocimacro, in java format
rather than VTL (eg "foo" or "bar" rather than "$foo" or "$bar")</dd>
<dd><code>context</code> - Context object containing data/objects used for rendering.</dd>
<dd><code>writer</code> - Writer for output stream</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if Velocimacro exists and successfully invoked, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="mergeTemplate-java.lang.String-java.lang.String-org.apache.velocity.context.Context-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeTemplate</h4>
<pre>public static&nbsp;boolean&nbsp;mergeTemplate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;templateName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding,
<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)
throws <a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a>,
<a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a>,
<a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a></pre>
<div class="block">Merges a template and puts the rendered stream into the writer</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>templateName</code> - name of template to be used in merge</dd>
<dd><code>encoding</code> - encoding used in template</dd>
<dd><code>context</code> - filled context to be used in merge</dd>
<dd><code>writer</code> - writer to write template into</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if successful, false otherwise. Errors
logged to velocity log</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - The template could not be parsed.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a></code> - A method on a context object could not be invoked.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - A referenced resource could not be loaded.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Velocity v1.1</dd>
</dl>
</li>
</ul>
<a name="getTemplate-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplate</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a>&nbsp;getTemplate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a>,
<a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></pre>
<div class="block">Returns a <code>Template</code> from the Velocity
resource management system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The file name of the desired template.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The template.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - if template not found
from any available source.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - if template cannot be parsed due
to syntax (or other) error.</dd>
</dl>
</li>
</ul>
<a name="getTemplate-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplate</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a>&nbsp;getTemplate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;encoding)
throws <a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a>,
<a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></pre>
<div class="block">Returns a <code>Template</code> from the Velocity
resource management system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The file name of the desired template.</dd>
<dd><code>encoding</code> - The character encoding to use for the template.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The template.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - if template not found
from any available source.</dd>
<dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - if template cannot be parsed due
to syntax (or other) error.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Velocity v1.1</dd>
</dl>
</li>
</ul>
<a name="resourceExists-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resourceExists</h4>
<pre>public static&nbsp;boolean&nbsp;resourceExists(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resourceName)</pre>
<div class="block"><p>Determines whether a resource is accessible via the
currently configured resource loaders. <a href="../../../../org/apache/velocity/runtime/resource/Resource.html" title="class in org.apache.velocity.runtime.resource"><code>Resource</code></a> is the generic
description of templates, static content, etc.</p>
<p>Note that the current implementation will <b>not</b> change
the state of the system in any real way - so this cannot be
used to pre-load the resource cache, as the previous
implementation did as a side-effect.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resourceName</code> - The name of the resource to search for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the resource was located.</dd>
</dl>
</li>
</ul>
<a name="getLog--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLog</h4>
<pre>public static&nbsp;org.slf4j.Logger&nbsp;getLog()</pre>
<div class="block">Returns the current logger.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A convenience Logger instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
</dl>
</li>
</ul>
<a name="setApplicationAttribute-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setApplicationAttribute</h4>
<pre>public static&nbsp;void&nbsp;setApplicationAttribute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block"><p>
Set the an ApplicationAttribue, which is an Object
set by the application which is accessible from
any component of the system that gets a RuntimeServices.
This allows communication between the application
environment and custom pluggable components of the
Velocity engine, such as loaders and loggers.
</p>
<p>
Note that there is no enforcement or rules for the key
used - it is up to the application developer. However, to
help make the intermixing of components possible, using
the target Class name (e.g. com.foo.bar ) as the key
might help avoid collision.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - object 'name' under which the object is stored</dd>
<dd><code>value</code> - object to store under this key</dd>
</dl>
</li>
</ul>
<a name="removeDirective-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeDirective</h4>
<pre>public&nbsp;void&nbsp;removeDirective(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Remove a directive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the directive.</dd>
</dl>
</li>
</ul>
<a name="loadDirective-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadDirective</h4>
<pre>public&nbsp;void&nbsp;loadDirective(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;directiveClass)</pre>
<div class="block">Instantiates and loads the directive with some basic checks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>directiveClass</code> - classname of directive to load</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Velocity.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/velocity/app/FieldMethodizer.html" title="class in org.apache.velocity.app"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/velocity/app/VelocityEngine.html" title="class in org.apache.velocity.app"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/velocity/app/Velocity.html" target="_top">Frames</a></li>
<li><a href="Velocity.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>