| <!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 Wed Jan 29 19:07:50 CET 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RuntimeServices (Apache Velocity 2.2 API)</title> |
| <meta name="date" content="2020-01-29"> |
| <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="RuntimeServices (Apache Velocity 2.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RuntimeServices.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/RuntimeInstance.html" title="class in org.apache.velocity.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/velocity/runtime/RuntimeSingleton.html" title="class 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/RuntimeServices.html" target="_top">Frames</a></li> |
| <li><a href="RuntimeServices.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface RuntimeServices" class="title">Interface RuntimeServices</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html" title="class in org.apache.velocity.runtime">RuntimeInstance</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RuntimeServices</span></pre> |
| <div class="block">Interface for internal runtime services that are needed by the |
| various components w/in Velocity. This was taken from the old |
| Runtime singleton, and anything not necessary was removed. |
| |
| Currently implemented by RuntimeInstance.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Id: RuntimeServices.java 1865687 2019-08-22 14:22:58Z cbrisson $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:geirm@optonline.net">Geir Magusson Jr.</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/RuntimeServices.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="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></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="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/parser/Parser.html" title="interface in org.apache.velocity.runtime.parser">Parser</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#createNewParser--">createNewParser</a></span>()</code> |
| <div class="block">Create a new parser instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></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="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></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="i6" 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/RuntimeServices.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">Return the specified application attribute.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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/RuntimeServices.html#getApplicationEventCartridge--">getApplicationEventCartridge</a></span>()</code> |
| <div class="block">Returns the event handlers for the application.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="i9" class="rowColor"> |
| <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/RuntimeServices.html#getConfiguration--">getConfiguration</a></span>()</code> |
| <div class="block">Return the velocity runtime configuration object.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/RuntimeServices.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="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/RuntimeServices.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="i12" 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/RuntimeServices.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="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="i15" 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/RuntimeServices.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 is a template exists, and returns name of the loader that |
| provides it.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getLog--">getLog</a></span>()</code> |
| <div class="block">Returns the configured logger.</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/RuntimeServices.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="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/parser/LogContext.html" title="class in org.apache.velocity.runtime.parser">LogContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getLogContext--">getLogContext</a></span>()</code> |
| <div class="block">Get the LogContext object used to tack locations in templates.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/velocity/runtime/ParserConfiguration.html" title="class in org.apache.velocity.runtime">ParserConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#getParserConfiguration--">getParserConfiguration</a></span>()</code> |
| <div class="block">Get the replacement characters configured for this runtime service's parser</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/RuntimeServices.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="i21" class="rowColor"> |
| <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/RuntimeServices.html#getSpaceGobbling--">getSpaceGobbling</a></span>()</code> |
| <div class="block">get space gobbling mode</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/RuntimeServices.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="i23" 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/RuntimeServices.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="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/RuntimeServices.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="i25" 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/RuntimeServices.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="i26" class="altColor"> |
| <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/RuntimeServices.html#getUberspect--">getUberspect</a></span>()</code> |
| <div class="block">Returns the configured class introspection/reflection |
| implementation.</div> |
| </td> |
| </tr> |
| <tr id="i27" 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/RuntimeServices.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 strVMname |
| is a valid current Velocimacro.</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/RuntimeServices.html#init--">init</a></span>()</code> |
| <div class="block">This is the primary initialization method in the Velocity |
| Runtime.</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/RuntimeServices.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="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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 the name of |
| ExtProperties object.</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/RuntimeServices.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="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#isHyphenAllowedInIdentifiers--">isHyphenAllowedInIdentifiers</a></span>()</code> |
| <div class="block">Get whether hyphens are allowed in identifiers</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/RuntimeServices.html#isInitialized--">isInitialized</a></span>()</code> |
| <div class="block">Returns true if the RuntimeInstance has been successfully initialized.</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/RuntimeServices.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="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="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/RuntimeServices.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><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/RuntimeServices.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> value)</code> |
| <div class="block">Set the specified application attribute.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.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="i40" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/velocity/runtime/RuntimeServices.html#useStringInterning--">useStringInterning</a></span>()</code> |
| <div class="block">Check whether the engine uses string interning</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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>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>Parser Pool</li> |
| <li>Global Cache</li> |
| <li>Static Content Include System</li> |
| <li>Velocimacro System</li> |
| </ul></div> |
| </li> |
| </ul> |
| <a name="setProperty-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>value</code> - property value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfiguration-org.apache.velocity.util.ExtProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfiguration</h4> |
| <pre>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="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>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="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>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="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><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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>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="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>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 the name of |
| ExtProperties object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configurationFile</code> - </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><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="paramLabel">Parameters:</span></dt> |
| <dd><code>reader</code> - inputstream retrieved by a resource loader</dd> |
| <dd><code>template</code> - template being parsed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The AST representing the template.</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></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>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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - context to use in rendering input string</dd> |
| <dd><code>out</code> - Writer in which to render the output</dd> |
| <dd><code>logTag</code> - string to be used as the template name for log |
| messages in case of error</dd> |
| <dd><code>instring</code> - input string containing the VTL to be rendered</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if successful, false otherwise. If false, see |
| Velocity runtime log</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - The template could not be parsed.</dd> |
| <dd><code><a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a></code> - A method on a context object could not be invoked.</dd> |
| <dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - A referenced resource could not be loaded.</dd> |
| <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>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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - context to use in rendering input string</dd> |
| <dd><code>writer</code> - Writer in which to render the output</dd> |
| <dd><code>logTag</code> - string to be used as the template name for log messages |
| in case of error</dd> |
| <dd><code>reader</code> - Reader containing the VTL to be rendered</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if successful, false otherwise. If false, see |
| Velocity runtime log</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - The template could not be parsed.</dd> |
| <dd><code><a href="../../../../org/apache/velocity/exception/MethodInvocationException.html" title="class in org.apache.velocity.exception">MethodInvocationException</a></code> - A method on a context object could not be invoked.</dd> |
| <dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - A referenced resource could not be loaded.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Velocity 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>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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vmName</code> - name of Velocimacro to call</dd> |
| <dd><code>logTag</code> - string to be used for template name in case of error. if null, |
| the vmName will be used</dd> |
| <dd><code>params</code> - keys for args used to invoke Velocimacro, in java format |
| rather than VTL (eg "foo" or "bar" rather than "$foo" or "$bar")</dd> |
| <dd><code>context</code> - Context object containing data/objects used for rendering.</dd> |
| <dd><code>writer</code> - Writer for output stream</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if Velocimacro exists and successfully invoked, false otherwise.</dd> |
| <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><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>input.encoding</code> |
| property. The default is UTF-8.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The file name of the desired template.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The template.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/velocity/exception/ResourceNotFoundException.html" title="class in org.apache.velocity.exception">ResourceNotFoundException</a></code> - if template not found |
| from any available source.</dd> |
| <dd><code><a href="../../../../org/apache/velocity/exception/ParseErrorException.html" title="class in org.apache.velocity.exception">ParseErrorException</a></code> - if template cannot be parsed due |
| to syntax (or other) error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTemplate-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTemplate</h4> |
| <pre><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="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><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="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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContent-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre><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="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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoaderNameForResource-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoaderNameForResource</h4> |
| <pre><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 is a template exists, and returns name of the loader that |
| provides it. This is a slightly less hokey way to support |
| the Velocity.templateExists() utility method, which was broken |
| when per-template encoding was introduced. We can revisit this.</div> |
| <dl> |
| <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="getString-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre><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="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>String 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><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 strVMname |
| is a valid current Velocimacro.</div> |
| <dl> |
| <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> - current template</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>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="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 macro definition</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>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="paramLabel">Parameters:</span></dt> |
| <dd><code>vmName</code> - Name of velocimacro</dd> |
| <dd><code>template</code> - Template "namespace"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean 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><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="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>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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInt-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>defaultValue</code> - default value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBoolean-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre>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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - property key</dd> |
| <dd><code>def</code> - default default value if property not found</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean value of key or default value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre><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="returnLabel">Returns:</span></dt> |
| <dd>ExtProperties configuration object which houses |
| the velocity runtime properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationAttribute-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationAttribute</h4> |
| <pre><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">Return the specified application attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The name of the attribute to retrieve.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value of the attribute.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setApplicationAttribute-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setApplicationAttribute</h4> |
| <pre><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> value)</pre> |
| <div class="block">Set the specified application attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The name of the attribute to set.</dd> |
| <dd><code>value</code> - The attribute value to set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the displaced attribute value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUberspect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUberspect</h4> |
| <pre><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 configured class introspection/reflection |
| implementation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The current Uberspect object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLog--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLog</h4> |
| <pre>org.slf4j.Logger getLog()</pre> |
| <div class="block">Returns the configured logger.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Logger object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLog-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLog</h4> |
| <pre>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="paramLabel">Parameters:</span></dt> |
| <dd><code>childNamespace</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>child name space logger</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLogContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogContext</h4> |
| <pre><a href="../../../../org/apache/velocity/runtime/parser/LogContext.html" title="class in org.apache.velocity.runtime.parser">LogContext</a> getLogContext()</pre> |
| <div class="block">Get the LogContext object used to tack locations in templates.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>LogContext object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationEventCartridge--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationEventCartridge</h4> |
| <pre><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="returnLabel">Returns:</span></dt> |
| <dd>The event handlers for the application.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isInitialized--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInitialized</h4> |
| <pre>boolean isInitialized()</pre> |
| <div class="block">Returns true if the RuntimeInstance has been successfully initialized.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the RuntimeInstance has been successfully initialized.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createNewParser--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNewParser</h4> |
| <pre><a href="../../../../org/apache/velocity/runtime/parser/Parser.html" title="interface in org.apache.velocity.runtime.parser">Parser</a> createNewParser()</pre> |
| <div class="block">Create a new parser instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new parser instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDirective-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDirective</h4> |
| <pre><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="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the directive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the directive with that name, if any</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="useStringInterning--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useStringInterning</h4> |
| <pre>boolean useStringInterning()</pre> |
| <div class="block">Check whether the engine uses string interning</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if string interning is active</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSpaceGobbling--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpaceGobbling</h4> |
| <pre><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="returnLabel">Returns:</span></dt> |
| <dd>space gobbling mode</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHyphenAllowedInIdentifiers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHyphenAllowedInIdentifiers</h4> |
| <pre>boolean isHyphenAllowedInIdentifiers()</pre> |
| <div class="block">Get whether hyphens are allowed in identifiers</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>configured boolean flag</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isScopeControlEnabled-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isScopeControlEnabled</h4> |
| <pre>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="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> |
| <a name="getParserConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getParserConfiguration</h4> |
| <pre><a href="../../../../org/apache/velocity/runtime/ParserConfiguration.html" title="class in org.apache.velocity.runtime">ParserConfiguration</a> getParserConfiguration()</pre> |
| <div class="block">Get the replacement characters configured for this runtime service's parser</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>configured replacement characters</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</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/RuntimeServices.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/RuntimeInstance.html" title="class in org.apache.velocity.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/velocity/runtime/RuntimeSingleton.html" title="class 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/RuntimeServices.html" target="_top">Frames</a></li> |
| <li><a href="RuntimeServices.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |