Google Git
Sign in
apache / velocity-site / 7a9b64e1165f8ef26c842c56fdc0b45a47cccaa6 / . / src / content / tools / devel / apidocs / org / apache / velocity / tools / generic / class-use / LoopTool.ManagedIterator.html
blob: 1a0e7c96b8be7d4346e51f5321f1800129fe40b3 [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 Mon Mar 08 21:15:19 CET 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.apache.velocity.tools.generic.LoopTool.ManagedIterator (VelocityTools 3.2-SNAPSHOT API)</title>
<meta name="date" content="2021-03-08">
<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="Uses of Class org.apache.velocity.tools.generic.LoopTool.ManagedIterator (VelocityTools 3.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/velocity/tools/generic/class-use/LoopTool.ManagedIterator.html" target="_top">Frames</a></li>
<li><a href="LoopTool.ManagedIterator.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.velocity.tools.generic.LoopTool.ManagedIterator" class="title">Uses of Class<br>org.apache.velocity.tools.generic.LoopTool.ManagedIterator</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.velocity.tools.generic">org.apache.velocity.tools.generic</a></td>
<td class="colLast">
<div class="block">Contains a collection of reusable, general-purpose "tools" for Velocity.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.velocity.tools.generic">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a> in <a href="../../../../../../org/apache/velocity/tools/generic/package-summary.html">org.apache.velocity.tools.generic</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../org/apache/velocity/tools/generic/package-summary.html">org.apache.velocity.tools.generic</a> that return <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.ManagedIterator.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html#condition-org.apache.velocity.tools.generic.LoopTool.ActionCondition-">condition</a></span>(<a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ActionCondition.html" title="class in org.apache.velocity.tools.generic">LoopTool.ActionCondition</a>&nbsp;condition)</code>
<div class="block">Adds a new <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ActionCondition.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ActionCondition</code></a> for this instance to check
against the elements in the iterator being managed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.ManagedIterator.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html#exclude-java.lang.Object-">exclude</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;compare)</code>
<div class="block">Directs this instance to completely exclude
any elements equal to the specified Object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#findIterator-java.lang.String-">findIterator</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">Finds the <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ManagedIterator</code></a> with the specified name
if it is in this instance's iterator stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#getThis--">getThis</a></span>()</code>
<div class="block">Returns the most recent <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ManagedIterator</code></a> for this instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#manage-java.util.Iterator-java.lang.String-">manage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;iterator,
<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>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#pop--">pop</a></span>()</code>
<div class="block">Don't let templates call this, but allow subclasses
and ManagedIterator to have access.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.ManagedIterator.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html#stop-java.lang.Object-">stop</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;compare)</code>
<div class="block">Directs this instance to stop iterating immediately prior to
any element equal to the specified Object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.ManagedIterator.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html#sync-java.lang.Object-">sync</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;iterable)</code>
<div class="block">Adds another iterator to be kept in sync with the one
being managed by this instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#sync-java.lang.Object-java.lang.Object-">sync</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;main,
<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;synced)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.ManagedIterator.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html#sync-java.lang.Object-java.lang.String-">sync</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;iterable,
<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">Adds another iterator to be kept in sync with the one
being managed by this instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#watch-java.lang.Object-">watch</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>
<div class="block">Tells the LoopTool to watch the specified Array, Collection, Map,
Iterator, Iterable, Enumeration or POJO with an iterator() method
while the template iterates over the values within it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">LoopTool.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#watch-java.lang.Object-java.lang.String-">watch</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj,
<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">This is just like <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.html#watch-java.lang.Object-"><code>LoopTool.watch(Object)</code></a> except that it also takes
a name which is given to the <a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ManagedIterator</code></a> that is returned.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/velocity/tools/generic/class-use/LoopTool.ManagedIterator.html" target="_top">Frames</a></li>
<li><a href="LoopTool.ManagedIterator.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>