Google Git
Sign in
apache / velocity-site / 6dbe1cbb36381ff877ae00f97d6bfdb964a782dc / . / src / content / engine / 2.3 / apidocs / org / apache / velocity / runtime / directive / VelocimacroProxy.html
blob: ee1a20eedda982200d4eaaf539667c72934d616f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_191) on Sat Feb 27 13:52:04 CET 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VelocimacroProxy (Apache Velocity 2.3 API)</title>
<meta name="date" content="2021-02-27">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="VelocimacroProxy (Apache Velocity 2.3 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};
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/VelocimacroProxy.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/directive/StopCommand.html" title="class in org.apache.velocity.runtime.directive"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/runtime/directive/VelocimacroProxy.html" target="_top">Frames</a></li>
<li><a href="VelocimacroProxy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.velocity.runtime.directive.Directive">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.velocity.runtime.directive</div>
<h2 title="Class VelocimacroProxy" class="title">Class VelocimacroProxy</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><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">org.apache.velocity.runtime.directive.Directive</a></li>
<li>
<ul class="inheritance">
<li>org.apache.velocity.runtime.directive.VelocimacroProxy</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../../org/apache/velocity/runtime/directive/DirectiveConstants.html" title="interface in org.apache.velocity.runtime.directive">DirectiveConstants</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">VelocimacroProxy</span>
extends <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></pre>
<div class="block">VelocimacroProxy.java
a proxy Directive-derived object to fit with the current directive system</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id$</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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.directive.Directive">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.velocity.runtime.directive.<a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></h3>
<code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#log">log</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#rsvc">rsvc</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.runtime.directive.DirectiveConstants">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.velocity.runtime.directive.<a href="../../../../../org/apache/velocity/runtime/directive/DirectiveConstants.html" title="interface in org.apache.velocity.runtime.directive">DirectiveConstants</a></h3>
<code><a href="../../../../../org/apache/velocity/runtime/directive/DirectiveConstants.html#BLOCK">BLOCK</a>, <a href="../../../../../org/apache/velocity/runtime/directive/DirectiveConstants.html#LINE">LINE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#VelocimacroProxy--">VelocimacroProxy</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#checkArgumentCount-org.apache.velocity.runtime.parser.node.Node-int-">checkArgumentCount</a></span>(<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node,
int&nbsp;callArgNum)</code>
<div class="block">Check whether the number of arguments given matches the number defined.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#checkDepth-org.apache.velocity.context.InternalContextAdapter-">checkDepth</a></span>(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context)</code>
<div class="block">check that we aren't already at the max call depth and throws
a MacroOverflowException if we are there.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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>&lt;<a href="../../../../../org/apache/velocity/runtime/directive/Macro.MacroArg.html" title="class in org.apache.velocity.runtime.directive">Macro.MacroArg</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#getMacroArgs--">getMacroArgs</a></span>()</code>
<div class="block">Return the list of macro arguments associated with this macro</div>
</td>
</tr>
<tr id="i3" 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/directive/VelocimacroProxy.html#getName--">getName</a></span>()</code>
<div class="block">Return name of this Velocimacro.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#getNumArgs--">getNumArgs</a></span>()</code>
<div class="block">returns the number of ars needed for this VM</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#getType--">getType</a></span>()</code>
<div class="block">Velocimacros are always LINE type directives.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <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/directive/VelocimacroProxy.html#handleArgValues-org.apache.velocity.context.InternalContextAdapter-org.apache.velocity.runtime.parser.node.Node-int-">handleArgValues</a></span>(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context,
<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node,
int&nbsp;callArgNum)</code>
<div class="block">Gets the macro argument values and puts them in the context under
the argument names.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#init-org.apache.velocity.runtime.RuntimeServices-">init</a></span>(<a href="../../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a>&nbsp;rs)</code>
<div class="block">Initialize members of VelocimacroProxy.</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/directive/VelocimacroProxy.html#render-org.apache.velocity.context.InternalContextAdapter-java.io.Writer-org.apache.velocity.runtime.parser.node.Node-">render</a></span>(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node)</code>
<div class="block">Render the macro AST node</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/directive/VelocimacroProxy.html#render-org.apache.velocity.context.InternalContextAdapter-java.io.Writer-org.apache.velocity.runtime.parser.node.Node-org.apache.velocity.runtime.Renderable-">render</a></span>(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node,
<a href="../../../../../org/apache/velocity/runtime/Renderable.html" title="interface in org.apache.velocity.runtime">Renderable</a>&nbsp;body)</code>
<div class="block">Renders the macro using the context.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#setMacroArgs-java.util.List-">setMacroArgs</a></span>(<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>&lt;<a href="../../../../../org/apache/velocity/runtime/directive/Macro.MacroArg.html" title="class in org.apache.velocity.runtime.directive">Macro.MacroArg</a>&gt;&nbsp;args)</code>
<div class="block">sets the array of arguments specified in the macro definition</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#setName-java.lang.String-">setName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">sets the directive name of this VM</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html#setNodeTree-org.apache.velocity.runtime.parser.node.SimpleNode-">setNodeTree</a></span>(<a href="../../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node">SimpleNode</a>&nbsp;tree)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.runtime.directive.Directive">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.velocity.runtime.directive.<a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></h3>
<code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#checkArgs-java.util.ArrayList-org.apache.velocity.runtime.parser.Token-java.lang.String-">checkArgs</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getColumn--">getColumn</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getLine--">getLine</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getScopeName--">getScopeName</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getTemplate--">getTemplate</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getTemplateName--">getTemplateName</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#init-org.apache.velocity.runtime.RuntimeServices-org.apache.velocity.context.InternalContextAdapter-org.apache.velocity.runtime.parser.node.Node-">init</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#isScopeProvided--">isScopeProvided</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#makeScope-java.lang.Object-">makeScope</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#postRender-org.apache.velocity.context.InternalContextAdapter-">postRender</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#preRender-org.apache.velocity.context.InternalContextAdapter-">preRender</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#setLocation-int-int-">setLocation</a>, <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#setLocation-int-int-org.apache.velocity.Template-">setLocation</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="VelocimacroProxy--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VelocimacroProxy</h4>
<pre>public&nbsp;VelocimacroProxy()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Return name of this Velocimacro.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getName--">getName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of this Velocimacro.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;int&nbsp;getType()</pre>
<div class="block">Velocimacros are always LINE type directives.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#getType--">getType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The type of this directive.</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">sets the directive name of this VM</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - </dd>
</dl>
</li>
</ul>
<a name="setMacroArgs-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMacroArgs</h4>
<pre>public&nbsp;void&nbsp;setMacroArgs(<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>&lt;<a href="../../../../../org/apache/velocity/runtime/directive/Macro.MacroArg.html" title="class in org.apache.velocity.runtime.directive">Macro.MacroArg</a>&gt;&nbsp;args)</pre>
<div class="block">sets the array of arguments specified in the macro definition</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - Array of macro arguments, containing the
#macro() arguments and default values. the 0th is the name.</dd>
</dl>
</li>
</ul>
<a name="getMacroArgs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMacroArgs</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../org/apache/velocity/runtime/directive/Macro.MacroArg.html" title="class in org.apache.velocity.runtime.directive">Macro.MacroArg</a>&gt;&nbsp;getMacroArgs()</pre>
<div class="block">Return the list of macro arguments associated with this macro</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>macro arguments</dd>
</dl>
</li>
</ul>
<a name="setNodeTree-org.apache.velocity.runtime.parser.node.SimpleNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNodeTree</h4>
<pre>public&nbsp;void&nbsp;setNodeTree(<a href="../../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html" title="class in org.apache.velocity.runtime.parser.node">SimpleNode</a>&nbsp;tree)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tree</code> - </dd>
</dl>
</li>
</ul>
<a name="getNumArgs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumArgs</h4>
<pre>public&nbsp;int&nbsp;getNumArgs()</pre>
<div class="block">returns the number of ars needed for this VM</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of ars needed for this VM</dd>
</dl>
</li>
</ul>
<a name="init-org.apache.velocity.runtime.RuntimeServices-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</a>&nbsp;rs)</pre>
<div class="block">Initialize members of VelocimacroProxy. called from MacroEntry</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rs</code> - runtime services</dd>
</dl>
</li>
</ul>
<a name="render-org.apache.velocity.context.InternalContextAdapter-java.io.Writer-org.apache.velocity.runtime.parser.node.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>render</h4>
<pre>public&nbsp;boolean&nbsp;render(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Render the macro AST node</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html#render-org.apache.velocity.context.InternalContextAdapter-java.io.Writer-org.apache.velocity.runtime.parser.node.Node-">render</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/runtime/directive/Directive.html" title="class in org.apache.velocity.runtime.directive">Directive</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - </dd>
<dd><code>writer</code> - </dd>
<dd><code>node</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>success status</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="render-org.apache.velocity.context.InternalContextAdapter-java.io.Writer-org.apache.velocity.runtime.parser.node.Node-org.apache.velocity.runtime.Renderable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>render</h4>
<pre>public&nbsp;boolean&nbsp;render(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node,
<a href="../../../../../org/apache/velocity/runtime/Renderable.html" title="interface in org.apache.velocity.runtime">Renderable</a>&nbsp;body)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Renders the macro using the context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - Current rendering context</dd>
<dd><code>writer</code> - Writer for output</dd>
<dd><code>node</code> - AST that calls the macro</dd>
<dd><code>body</code> - the macro body</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the directive rendered successfully.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="checkArgumentCount-org.apache.velocity.runtime.parser.node.Node-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkArgumentCount</h4>
<pre>protected&nbsp;void&nbsp;checkArgumentCount(<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node,
int&nbsp;callArgNum)</pre>
<div class="block">Check whether the number of arguments given matches the number defined.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - </dd>
<dd><code>callArgNum</code> - </dd>
</dl>
</li>
</ul>
<a name="checkDepth-org.apache.velocity.context.InternalContextAdapter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkDepth</h4>
<pre>protected&nbsp;void&nbsp;checkDepth(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context)</pre>
<div class="block">check that we aren't already at the max call depth and throws
a MacroOverflowException if we are there.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - </dd>
</dl>
</li>
</ul>
<a name="handleArgValues-org.apache.velocity.context.InternalContextAdapter-org.apache.velocity.runtime.parser.node.Node-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleArgValues</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;handleArgValues(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html" title="interface in org.apache.velocity.context">InternalContextAdapter</a>&nbsp;context,
<a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html" title="interface in org.apache.velocity.runtime.parser.node">Node</a>&nbsp;node,
int&nbsp;callArgNum)</pre>
<div class="block">Gets the macro argument values and puts them in the context under
the argument names. Store and return an array of old and new values
paired for each argument name, for later cleanup. Also, put literal
representations of arguments which evaluate to null in the context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - </dd>
<dd><code>node</code> - </dd>
<dd><code>callArgNum</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>macro arguments values</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/VelocimacroProxy.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/directive/StopCommand.html" title="class in org.apache.velocity.runtime.directive"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/runtime/directive/VelocimacroProxy.html" target="_top">Frames</a></li>
<li><a href="VelocimacroProxy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.velocity.runtime.directive.Directive">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>