| <!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 Fri Mar 15 15:10:10 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RuntimeInstance (Apache Velocity 2.1 API)</title> |
| <meta name="date" content="2019-03-15"> |
| <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="RuntimeInstance (Apache Velocity 2.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10}; |
| var tabs = {65535:["t0","All 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/RuntimeInstance.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/runtime/RuntimeConstants.SpaceGobbling.html" title="enum in org.apache.velocity.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/velocity/runtime/RuntimeInstance.html" target="_top">Frames</a></li> |
| <li><a href="RuntimeInstance.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.runtime</div> |
| <h2 title="Class RuntimeInstance" class="title">Class RuntimeInstance</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.runtime.RuntimeInstance</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>, <a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RuntimeInstance</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>, <a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></pre> |
| <div class="block"><p>This is the Runtime system for Velocity. It is the |
| single access point for all functionality in Velocity. |
| It adheres to the mediator pattern and is the only |
| structure that developers need to be familiar with |
| in order to get Velocity to perform.</p> |
| |
| <p>The Runtime will also cooperate with external |
| systems, which can make all needed setProperty() calls |
| before calling init().</p> |
| <pre> |
| ----------------------------------------------------------------------- |
| N O T E S O N R U N T I M E I N I T I A L I Z A T I O N |
| ----------------------------------------------------------------------- |
| init() |
| |
| If init() is called by itself the RuntimeInstance will initialize |
| with a set of default values. |
| ----------------------------------------------------------------------- |
| init(String/Properties) |
| |
| In this case the default velocity properties are layed down |
| first to provide a solid base, then any properties provided |
| in the given properties object will override the corresponding |
| default property. |
| ----------------------------------------------------------------------- |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Id: RuntimeInstance.java 1855594 2019-03-15 13:51:36Z cbrisson $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>, <a href="mailto:jlb@houseofdistraction.com">Jeff Bowden</a>, <a href="mailto:geirm@optonline.net">Geir Magusson Jr.</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 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 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_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_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_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_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_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>, <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.html#VM_PRESERVE_ARGUMENTS_LITERALS">VM_PRESERVE_ARGUMENTS_LITERALS</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 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_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"> </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/runtime/RuntimeInstance.html#RuntimeInstance--">RuntimeInstance</a></span>()</code> |
| <div class="block">Creates a new RuntimeInstance object.</div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#addDirective-org.apache.velocity.runtime.directive.Directive-">addDirective</a></span>(<a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a> directive)</code> |
| <div class="block">Programatically add a directive.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> 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> value)</code> |
| <div class="block">Add a property to the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#addVelocimacro-java.lang.String-org.apache.velocity.runtime.parser.node.Node-java.util.List-org.apache.velocity.Template-">addVelocimacro</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> name, |
| <a href="../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a> macro, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/velocity/runtime/directive/Macro.MacroArg.html" title="class in org.apache.velocity.runtime.directive">Macro.MacroArg</a>> macroArgs, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> definingTemplate)</code> |
| <div class="block">Adds a new Velocimacro.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> key)</code> |
| <div class="block">Clear the values pertaining to a particular |
| property.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/parser/Parser.html" title="class in org.apache.velocity.runtime.parser">Parser</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#createNewParser--">createNewParser</a></span>()</code> |
| <div class="block">Returns a JavaCC generated Parser.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> 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> 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> 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> reader)</code> |
| <div class="block">Renders the input reader using the context into the output writer.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> 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> 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> 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> instring)</code> |
| <div class="block">Renders the input string using the context into the output writer.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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/runtime/RuntimeInstance.html#getApplicationAttribute-java.lang.Object-">getApplicationAttribute</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> key)</code> |
| <div class="block">Gets the application attribute for the given key</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/app/event/EventCartridge.html" title="class in org.apache.velocity.app.event">EventCartridge</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getApplicationEventCartridge--">getApplicationEventCartridge</a></span>()</code> |
| <div class="block">Returns the event handlers for the application.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getBoolean-java.lang.String-boolean-">getBoolean</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> key, |
| boolean def)</code> |
| <div class="block">Boolean property accessor method to hide the configuration implementation.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/util/ExtProperties.html" title="class in org.apache.velocity.util">ExtProperties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getConfiguration--">getConfiguration</a></span>()</code> |
| <div class="block">Return the velocity runtime configuration object.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/resource/ContentResource.html" title="class in org.apache.velocity.runtime.resource">ContentResource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getContent-java.lang.String-">getContent</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> name)</code> |
| <div class="block">Returns a static content resource from the |
| resource manager.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/resource/ContentResource.html" title="class in org.apache.velocity.runtime.resource">ContentResource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getContent-java.lang.String-java.lang.String-">getContent</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> 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> encoding)</code> |
| <div class="block">Returns a static content resource from the |
| resource manager.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getDirective-java.lang.String-">getDirective</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> name)</code> |
| <div class="block">Retrieve a previously instantiated directive.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getInt-java.lang.String-">getInt</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> key)</code> |
| <div class="block">Int property accessor method to hide the configuration implementation.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getInt-java.lang.String-int-">getInt</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> key, |
| int defaultValue)</code> |
| <div class="block">Int property accessor method to hide the configuration implementation.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getLoaderNameForResource-java.lang.String-">getLoaderNameForResource</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> resourceName)</code> |
| <div class="block">Determines if a template exists and returns name of the loader that |
| provides it.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getLog--">getLog</a></span>()</code> |
| <div class="block">Returns the configured logger.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getLog-java.lang.String-">getLog</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> childNamespace)</code> |
| <div class="block">Get a logger for the specified child namespace.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><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/runtime/RuntimeInstance.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> key)</code> |
| <div class="block">Allows an external caller to get a property.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/RuntimeConstants.SpaceGobbling.html" title="enum in org.apache.velocity.runtime">RuntimeConstants.SpaceGobbling</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getSpaceGobbling--">getSpaceGobbling</a></span>()</code> |
| <div class="block">get space gobbling mode</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getString-java.lang.String-">getString</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> key)</code> |
| <div class="block">String property accessor method to hide the configuration implementation</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getString-java.lang.String-java.lang.String-">getString</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> key, |
| <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> defaultValue)</code> |
| <div class="block">String property accessor method with default to hide the |
| configuration implementation.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><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/runtime/RuntimeInstance.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> name)</code> |
| <div class="block">Returns a <code>Template</code> from the resource manager.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><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/runtime/RuntimeInstance.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> 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> encoding)</code> |
| <div class="block">Returns a <code>Template</code> from the resource manager</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/util/introspection/Uberspect.html" title="interface in org.apache.velocity.util.introspection">Uberspect</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getUberspect--">getUberspect</a></span>()</code> |
| <div class="block">Returns the Uberspect object for this Instance.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#getVelocimacro-java.lang.String-org.apache.velocity.Template-org.apache.velocity.Template-">getVelocimacro</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> vmName, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> renderingTemplate, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> template)</code> |
| <div class="block">Returns the appropriate VelocimacroProxy object if vmName |
| is a valid current Velocimacro.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#init--">init</a></span>()</code> |
| <div class="block">This is the primary initialization method in the Velocity |
| Runtime.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> p)</code> |
| <div class="block">Initialize the Velocity Runtime with a Properties |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> configurationFile)</code> |
| <div class="block">Initialize the Velocity Runtime with a |
| properties file path.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> 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> 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>[] params, |
| <a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a> 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> 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="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#isHyphenAllowedInIdentifiers--">isHyphenAllowedInIdentifiers</a></span>()</code> |
| <div class="block">get whether hyphens are allowed in identifiers</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#isInitialized--">isInitialized</a></span>()</code> |
| <div class="block">Returns true if the RuntimeInstance has been successfully initialized.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#isScopeControlEnabled-java.lang.String-">isScopeControlEnabled</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> scopeName)</code> |
| <div class="block">Get whether to provide a scope control object for this scope</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#isVelocimacro-java.lang.String-org.apache.velocity.Template-">isVelocimacro</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> vmName, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> template)</code> |
| <div class="block">Checks to see if a VM exists</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> directiveClass)</code> |
| <div class="block">instantiates and loads the directive with some basic checks</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node">SimpleNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#parse-java.io.Reader-org.apache.velocity.Template-">parse</a></span>(<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> reader, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> template)</code> |
| <div class="block">Parse the input and return the root of |
| AST node structure.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> name)</code> |
| <div class="block">Remove a directive.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#render-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-org.apache.velocity.runtime.parser.node.SimpleNode-">render</a></span>(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a> 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> 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> logTag, |
| <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node">SimpleNode</a> nodeTree)</code> |
| <div class="block">Initializes and renders the AST <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node"><code>SimpleNode</code></a> using the context |
| into the output writer.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#reset--">reset</a></span>()</code> |
| <div class="block">Resets the instance, so Velocity can be re-initialized again.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><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/runtime/RuntimeInstance.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> 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> o)</code> |
| <div class="block">Sets the application attribute for the given key</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#setConfiguration-org.apache.velocity.util.ExtProperties-">setConfiguration</a></span>(<a href="../../../../org/apache/velocity/util/ExtProperties.html" title="class in org.apache.velocity.util">ExtProperties</a> configuration)</code> |
| <div class="block">Allow an external system to set an ExtProperties |
| object to use.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> props)</code> |
| <div class="block">Add all the properties in props to the RuntimeInstance properties</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#setProperties-java.lang.String-">setProperties</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> fileName)</code> |
| <div class="block">Add all properties contained in the file fileName to the RuntimeInstance properties</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.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> 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> value)</code> |
| <div class="block">Allows an external system to set a property in |
| the Velocity Runtime.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html#useStringInterning--">useStringInterning</a></span>()</code> |
| <div class="block">Whether to use string interning</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 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="RuntimeInstance--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RuntimeInstance</h4> |
| <pre>public RuntimeInstance()</pre> |
| <div class="block">Creates a new RuntimeInstance object.</div> |
| </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 void init()</pre> |
| <div class="block">This is the primary initialization method in the Velocity |
| Runtime. The systems that are setup/initialized here are |
| as follows: |
| |
| <ul> |
| <li>Logging System</li> |
| <li>ResourceManager</li> |
| <li>EventHandler</li> |
| <li>Parser Pool</li> |
| <li>Global Cache</li> |
| <li>Static Content Include System</li> |
| <li>Velocimacro System</li> |
| </ul></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#init--">init</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void 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="isInitialized--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInitialized</h4> |
| <pre>public boolean isInitialized()</pre> |
| <div class="block">Returns true if the RuntimeInstance has been successfully initialized.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#isInitialized--">isInitialized</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the RuntimeInstance has been successfully initialized.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5</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 void 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> 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> value)</pre> |
| <div class="block">Allows an external system to set a property in |
| the Velocity Runtime.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>value</code> - property value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProperties-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre>public void setProperties(<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> fileName)</pre> |
| <div class="block">Add all properties contained in the file fileName to the RuntimeInstance properties</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fileName</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProperties-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre>public void 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> props)</pre> |
| <div class="block">Add all the properties in props to the RuntimeInstance properties</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>props</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfiguration-org.apache.velocity.util.ExtProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfiguration</h4> |
| <pre>public void setConfiguration(<a href="../../../../org/apache/velocity/util/ExtProperties.html" title="class in org.apache.velocity.util">ExtProperties</a> configuration)</pre> |
| <div class="block">Allow an external system to set an ExtProperties |
| object to use.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#setConfiguration-org.apache.velocity.util.ExtProperties-">setConfiguration</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configuration</code> - </dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</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 void 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> 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> value)</pre> |
| <div class="block">Add a property to the configuration. If it already |
| exists then the value stated here will be added |
| to the configuration entry. For example, if |
| |
| resource.loader = file |
| |
| is already present in the configuration and you |
| |
| addProperty("resource.loader", "classpath") |
| |
| Then you will end up with a Vector like the |
| following: |
| |
| ["file", "classpath"]</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#addProperty-java.lang.String-java.lang.Object-">addProperty</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - </dd> |
| <dd><code>value</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearProperty</h4> |
| <pre>public void 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> key)</pre> |
| <div class="block">Clear the values pertaining to a particular |
| property.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#clearProperty-java.lang.String-">clearProperty</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - of property to clear</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <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> 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> key)</pre> |
| <div class="block">Allows an external caller to get a property. The calling |
| routine is required to know the type, as this routine |
| will return an Object, as that is what properties can be.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getProperty-java.lang.String-">getProperty</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Value of the property or null if it does not exist.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void 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> p)</pre> |
| <div class="block">Initialize the Velocity Runtime with a Properties |
| object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#init-java.util.Properties-">init</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - Velocity properties for initialization</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void 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> configurationFile)</pre> |
| <div class="block">Initialize the Velocity Runtime with a |
| properties file path.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#init-java.lang.String-">init</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configurationFile</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addDirective-org.apache.velocity.runtime.directive.Directive-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDirective</h4> |
| <pre>public void addDirective(<a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a> directive)</pre> |
| <div class="block">Programatically add a directive.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>directive</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDirective-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDirective</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a> getDirective(<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> name)</pre> |
| <div class="block">Retrieve a previously instantiated directive.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getDirective-java.lang.String-">getDirective</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the directive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive"><code>Directive</code></a> for that name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeDirective-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDirective</h4> |
| <pre>public void 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> 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="blockList"> |
| <li class="blockList"> |
| <h4>loadDirective</h4> |
| <pre>public void 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> 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> |
| <a name="createNewParser--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNewParser</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/parser/Parser.html" title="class in org.apache.velocity.runtime.parser">Parser</a> createNewParser()</pre> |
| <div class="block">Returns a JavaCC generated Parser.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#createNewParser--">createNewParser</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Parser javacc generated parser</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parse-java.io.Reader-org.apache.velocity.Template-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parse</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node">SimpleNode</a> parse(<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> reader, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> template) |
| throws <a href="../../../../org/apache/velocity/runtime/parser/ParseException.html" title="class in org.apache.velocity.runtime.parser">ParseException</a></pre> |
| <div class="block">Parse the input and return the root of |
| AST node structure. |
| <br><br> |
| In the event that it runs out of parsers in the |
| pool, it will create and let them be GC'd |
| dynamically, logging that it has to do that. This |
| is considered an exceptional condition. It is |
| expected that the user will set the |
| PARSER_POOL_SIZE property appropriately for their |
| application. We will revisit this.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#parse-java.io.Reader-org.apache.velocity.Template-">parse</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reader</code> - Reader retrieved by a resource loader</dd> |
| <dd><code>template</code> - template being parsed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A root node representing the template as an AST tree.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/parser/ParseException.html" title="class in org.apache.velocity.runtime.parser">ParseException</a></code> - When the template could not be parsed.</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 boolean evaluate(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a> 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> 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> 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> instring)</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. |
| <br> |
| Note! Macros defined in evaluate() calls are not persisted in memory so next evaluate() call |
| does not know about macros defined during previous calls.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#evaluate-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-java.lang.String-">evaluate</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Velocity 1.6</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 boolean evaluate(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a> 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> 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> 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> reader)</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. |
| <br> |
| Note! Macros defined in evaluate() calls are not persisted in memory so next evaluate() call |
| does not know about macros defined during previous calls.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#evaluate-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-java.io.Reader-">evaluate</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <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 1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="render-org.apache.velocity.context.Context-java.io.Writer-java.lang.String-org.apache.velocity.runtime.parser.node.SimpleNode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>render</h4> |
| <pre>public boolean render(<a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a> 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> 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> logTag, |
| <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node">SimpleNode</a> nodeTree)</pre> |
| <div class="block">Initializes and renders the AST <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node"><code>SimpleNode</code></a> using the context |
| into the output writer.</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>nodeTree</code> - SimpleNode which is the root of the AST to be rendered</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if successful, false otherwise. If false, see |
| Velocity runtime log for errors</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 1.6</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 boolean 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> 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> 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>[] params, |
| <a href="../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</a> 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> 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. |
| <br> |
| Note: only macros in the global context can be called. This method doesn't find macros defined by |
| templates during previous mergeTemplate calls if Velocity.VM_PERM_INLINE_LOCAL has been enabled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#invokeVelocimacro-java.lang.String-java.lang.String-java.lang.String:A-org.apache.velocity.context.Context-java.io.Writer-">invokeVelocimacro</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTemplate-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTemplate</h4> |
| <pre>public <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> 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> 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 resource manager. |
| This method assumes that the character encoding of the |
| template is set by the <code>resource.default_encoding</code> |
| property. The default is UTF-8.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getTemplate-java.lang.String-">getTemplate</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <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 <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> 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> 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> 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 resource manager</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getTemplate-java.lang.String-java.lang.String-">getTemplate</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the desired template.</dd> |
| <dd><code>encoding</code> - Character encoding of 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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContent-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/resource/ContentResource.html" title="class in org.apache.velocity.runtime.resource">ContentResource</a> getContent(<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> 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 static content resource from the |
| resource manager. Uses the current value |
| if INPUT_ENCODING as the character encoding.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getContent-java.lang.String-">getContent</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of content resource to get</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parsed ContentResource object ready for use</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> - When the template could not be parsed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContent-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/resource/ContentResource.html" title="class in org.apache.velocity.runtime.resource">ContentResource</a> getContent(<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> 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> 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 static content resource from the |
| resource manager.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getContent-java.lang.String-java.lang.String-">getContent</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of content resource to get</dd> |
| <dd><code>encoding</code> - Character encoding to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parsed ContentResource object ready for use</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> - When the template could not be parsed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoaderNameForResource-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoaderNameForResource</h4> |
| <pre>public <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> getLoaderNameForResource(<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> resourceName)</pre> |
| <div class="block">Determines if a template exists and returns name of the loader that |
| provides it. This is a slightly less hokey way to support |
| the Velocity.resourceExists() utility method, which was broken |
| when per-template encoding was introduced. We can revisit this.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getLoaderNameForResource-java.lang.String-">getLoaderNameForResource</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceName</code> - Name of template or content resource</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>class name of loader than can provide it</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLog--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLog</h4> |
| <pre>public org.slf4j.Logger getLog()</pre> |
| <div class="block">Returns the configured logger.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getLog--">getLog</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Logger instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLog-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLog</h4> |
| <pre>public org.slf4j.Logger getLog(<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> childNamespace)</pre> |
| <div class="block">Get a logger for the specified child namespace. |
| If a logger was configured using the runtime.log.instance configuration property, returns this instance. |
| Otherwise, uses SLF4J LoggerFactory on baseNamespace '.' childNamespace.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getLog-java.lang.String-">getLog</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>childNamespace</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>child namespace logger</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getString-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre>public <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> getString(<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> key, |
| <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> defaultValue)</pre> |
| <div class="block">String property accessor method with default to hide the |
| configuration implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getString-java.lang.String-java.lang.String-">getString</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>defaultValue</code> - default value to return if key not |
| found in resource manager.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of key or default</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVelocimacro-java.lang.String-org.apache.velocity.Template-org.apache.velocity.Template-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVelocimacro</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a> getVelocimacro(<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> vmName, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> renderingTemplate, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> template)</pre> |
| <div class="block">Returns the appropriate VelocimacroProxy object if vmName |
| is a valid current Velocimacro.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getVelocimacro-java.lang.String-org.apache.velocity.Template-org.apache.velocity.Template-">getVelocimacro</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vmName</code> - Name of velocimacro requested</dd> |
| <dd><code>renderingTemplate</code> - Template we are currently rendering. This |
| information is needed when VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL setting is true |
| and template contains a macro with the same name as the global macro library.</dd> |
| <dd><code>template</code> - Template which acts as the host for the macro</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>VelocimacroProxy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addVelocimacro-java.lang.String-org.apache.velocity.runtime.parser.node.Node-java.util.List-org.apache.velocity.Template-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addVelocimacro</h4> |
| <pre>public boolean addVelocimacro(<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> name, |
| <a href="../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a> macro, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/velocity/runtime/directive/Macro.MacroArg.html" title="class in org.apache.velocity.runtime.directive">Macro.MacroArg</a>> macroArgs, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> definingTemplate)</pre> |
| <div class="block">Adds a new Velocimacro. Usually called by Macro only while parsing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#addVelocimacro-java.lang.String-org.apache.velocity.runtime.parser.node.Node-java.util.List-org.apache.velocity.Template-">addVelocimacro</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of velocimacro</dd> |
| <dd><code>macro</code> - root AST node of the parsed macro</dd> |
| <dd><code>macroArgs</code> - Array of macro arguments, containing the |
| #macro() arguments and default values. the 0th is the name.</dd> |
| <dd><code>definingTemplate</code> - Template containing the source of the macro</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean True if added, false if rejected for some |
| reason (either parameters or permission settings)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isVelocimacro-java.lang.String-org.apache.velocity.Template-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVelocimacro</h4> |
| <pre>public boolean isVelocimacro(<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> vmName, |
| <a href="../../../../org/apache/velocity/Template.html" title="class in org.apache.velocity">Template</a> template)</pre> |
| <div class="block">Checks to see if a VM exists</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#isVelocimacro-java.lang.String-org.apache.velocity.Template-">isVelocimacro</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vmName</code> - Name of the Velocimacro.</dd> |
| <dd><code>template</code> - Template on which to look for the Macro.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if VM by that name exists, false if not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre>public <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> getString(<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> key)</pre> |
| <div class="block">String property accessor method to hide the configuration implementation</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getString-java.lang.String-">getString</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of key or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInt-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>public int getInt(<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> key)</pre> |
| <div class="block">Int property accessor method to hide the configuration implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getInt-java.lang.String-">getInt</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - Property key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInt-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>public int getInt(<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> key, |
| int defaultValue)</pre> |
| <div class="block">Int property accessor method to hide the configuration implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getInt-java.lang.String-int-">getInt</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>defaultValue</code> - The default value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBoolean-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre>public boolean getBoolean(<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> key, |
| boolean def)</pre> |
| <div class="block">Boolean property accessor method to hide the configuration implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getBoolean-java.lang.String-boolean-">getBoolean</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>def</code> - The default value if property not found.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value of key or default value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre>public <a href="../../../../org/apache/velocity/util/ExtProperties.html" title="class in org.apache.velocity.util">ExtProperties</a> getConfiguration()</pre> |
| <div class="block">Return the velocity runtime configuration object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getConfiguration--">getConfiguration</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Configuration object which houses the Velocity runtime |
| properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationEventCartridge--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationEventCartridge</h4> |
| <pre>public <a href="../../../../org/apache/velocity/app/event/EventCartridge.html" title="class in org.apache.velocity.app.event">EventCartridge</a> getApplicationEventCartridge()</pre> |
| <div class="block">Returns the event handlers for the application.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getApplicationEventCartridge--">getApplicationEventCartridge</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The event handlers for the application.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationAttribute-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationAttribute</h4> |
| <pre>public <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> getApplicationAttribute(<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> key)</pre> |
| <div class="block">Gets the application attribute for the given key</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getApplicationAttribute-java.lang.Object-">getApplicationAttribute</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The application attribute for the given key.</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 <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> 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> 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> o)</pre> |
| <div class="block">Sets the application attribute for the given key</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#setApplicationAttribute-java.lang.Object-java.lang.Object-">setApplicationAttribute</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - </dd> |
| <dd><code>o</code> - The new application attribute.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The old value of this attribute or null if it hasn't been set before.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUberspect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUberspect</h4> |
| <pre>public <a href="../../../../org/apache/velocity/util/introspection/Uberspect.html" title="interface in org.apache.velocity.util.introspection">Uberspect</a> getUberspect()</pre> |
| <div class="block">Returns the Uberspect object for this Instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getUberspect--">getUberspect</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The Uberspect object for this Instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="useStringInterning--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useStringInterning</h4> |
| <pre>public boolean useStringInterning()</pre> |
| <div class="block">Whether to use string interning</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#useStringInterning--">useStringInterning</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSpaceGobbling--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpaceGobbling</h4> |
| <pre>public <a href="../../../../org/apache/velocity/runtime/RuntimeConstants.SpaceGobbling.html" title="enum in org.apache.velocity.runtime">RuntimeConstants.SpaceGobbling</a> getSpaceGobbling()</pre> |
| <div class="block">get space gobbling mode</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getSpaceGobbling--">getSpaceGobbling</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>indentation mode</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHyphenAllowedInIdentifiers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHyphenAllowedInIdentifiers</h4> |
| <pre>public boolean isHyphenAllowedInIdentifiers()</pre> |
| <div class="block">get whether hyphens are allowed in identifiers</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#isHyphenAllowedInIdentifiers--">isHyphenAllowedInIdentifiers</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>configured boolean flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isScopeControlEnabled-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isScopeControlEnabled</h4> |
| <pre>public boolean isScopeControlEnabled(<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> scopeName)</pre> |
| <div class="block">Get whether to provide a scope control object for this scope</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#isScopeControlEnabled-java.lang.String-">isScopeControlEnabled</a></code> in interface <code><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scopeName</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>scope control enabled</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</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/RuntimeInstance.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/runtime/RuntimeConstants.SpaceGobbling.html" title="enum in org.apache.velocity.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/velocity/runtime/RuntimeInstance.html" target="_top">Frames</a></li> |
| <li><a href="RuntimeInstance.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2000–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
