ProtocolLib/Javadoc/com/comphenix/protocol/wrappers/nbt/NbtVisitor.html
Kristian S. Stangeland e8f5bce3d5 Update JavaDoc for 2.3.0
2013-03-05 17:07:09 +01:00

287 lines
12 KiB
HTML

<!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 (version 1.7.0_13) on Tue Mar 05 17:05:45 CET 2013 -->
<title>NbtVisitor</title>
<meta name="date" content="2013-03-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NbtVisitor";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/NbtVisitor.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtType.html" title="enum in com.comphenix.protocol.wrappers.nbt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/wrappers/nbt/NbtVisitor.html" target="_top">Frames</a></li>
<li><a href="NbtVisitor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">com.comphenix.protocol.wrappers.nbt</div>
<h2 title="Interface NbtVisitor" class="title">Interface NbtVisitor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">NbtVisitor</span></pre>
<div class="block">A visitor that can enumerate a NBT tree structure.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Kristian</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</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>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html#visit(com.comphenix.protocol.wrappers.nbt.NbtBase)">visit</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a>&lt;?&gt;&nbsp;node)</code>
<div class="block">Visit a leaf node, which is a NBT tag with a primitive or String value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html#visitEnter(com.comphenix.protocol.wrappers.nbt.NbtCompound)">visitEnter</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a>&nbsp;compound)</code>
<div class="block">Begin visiting a compound node that contains multiple child nodes of different types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html#visitEnter(com.comphenix.protocol.wrappers.nbt.NbtList)">visitEnter</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;?&gt;&nbsp;list)</code>
<div class="block">Begin visiting a list node that contains multiple child nodes of the same type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html#visitLeave(com.comphenix.protocol.wrappers.nbt.NbtCompound)">visitLeave</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a>&nbsp;compound)</code>
<div class="block">Stop visiting a compound node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html#visitLeave(com.comphenix.protocol.wrappers.nbt.NbtList)">visitLeave</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;?&gt;&nbsp;list)</code>
<div class="block">Stop visiting a list node.</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="visit(com.comphenix.protocol.wrappers.nbt.NbtBase)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visit</h4>
<pre>boolean&nbsp;visit(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a>&lt;?&gt;&nbsp;node)</pre>
<div class="block">Visit a leaf node, which is a NBT tag with a primitive or String value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - - the visited leaf node.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE to continue visiting children at this level, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="visitEnter(com.comphenix.protocol.wrappers.nbt.NbtList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitEnter</h4>
<pre>boolean&nbsp;visitEnter(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;?&gt;&nbsp;list)</pre>
<div class="block">Begin visiting a list node that contains multiple child nodes of the same type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - - the NBT tag to process.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE to visit the child nodes of this list, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="visitEnter(com.comphenix.protocol.wrappers.nbt.NbtCompound)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitEnter</h4>
<pre>boolean&nbsp;visitEnter(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a>&nbsp;compound)</pre>
<div class="block">Begin visiting a compound node that contains multiple child nodes of different types.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>compound</code> - - the NBT tag to process.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE to visit the child nodes of this compound, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="visitLeave(com.comphenix.protocol.wrappers.nbt.NbtList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitLeave</h4>
<pre>boolean&nbsp;visitLeave(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;?&gt;&nbsp;list)</pre>
<div class="block">Stop visiting a list node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - - the list we're done visiting.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE for the parent to visit any subsequent sibling nodes, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="visitLeave(com.comphenix.protocol.wrappers.nbt.NbtCompound)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>visitLeave</h4>
<pre>boolean&nbsp;visitLeave(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a>&nbsp;compound)</pre>
<div class="block">Stop visiting a compound node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>compound</code> - - the compound we're done visting.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE for the parent to visit any subsequent sibling nodes, FALSE otherwise</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/NbtVisitor.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtType.html" title="enum in com.comphenix.protocol.wrappers.nbt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/comphenix/protocol/wrappers/nbt/NbtVisitor.html" target="_top">Frames</a></li>
<li><a href="NbtVisitor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>