ProtocolLib/Javadoc/com/comphenix/protocol/wrappers/nbt/NbtBase.html

338 lines
13 KiB
HTML
Raw Normal View History

2013-01-10 00:58:34 +01:00
<!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_07) on Thu Jan 10 00:56:14 CET 2013 -->
<title>NbtBase</title>
<meta name="date" content="2013-01-10">
<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="NbtBase";
}
//-->
</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/NbtBase.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>Prev Class</li>
<li><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.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/NbtBase.html" target="_top">Frames</a></li>
<li><a href="NbtBase.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 NbtBase" class="title">Interface NbtBase&lt;TType&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>TType</code> - - type of the value that is stored.</dd></dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a>, <a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;TType&gt;, <a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtWrapper</a>&lt;TType&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">NbtBase&lt;TType&gt;</span></pre>
<div class="block">Represents a generic container for an NBT element.
<p>
Use <a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtFactory.html" title="class in com.comphenix.protocol.wrappers.nbt"><code>NbtFactory</code></a> to load or create an instance.</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/NbtBase.html#accept(com.comphenix.protocol.wrappers.nbt.NbtVisitor)">accept</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtVisitor</a>&nbsp;visitor)</code>
<div class="block">Accepts a NBT visitor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a>&lt;<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="type parameter in NbtBase">TType</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html#deepClone()">deepClone</a></strong>()</code>
<div class="block">Clone the current NBT tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html#getName()">getName</a></strong>()</code>
<div class="block">Retrieve the name of this NBT tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtType.html" title="enum in com.comphenix.protocol.wrappers.nbt">NbtType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html#getType()">getType</a></strong>()</code>
<div class="block">Retrieve the type of this NBT element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="type parameter in NbtBase">TType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html#getValue()">getValue</a></strong>()</code>
<div class="block">Retrieve the value of this NBT tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html#setName(java.lang.String)">setName</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Set the name of this NBT tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html#setValue(TType)">setValue</a></strong>(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="type parameter in NbtBase">TType</a>&nbsp;newValue)</code>
<div class="block">Set the value of this NBT tag.</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="accept(com.comphenix.protocol.wrappers.nbt.NbtVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre>boolean&nbsp;accept(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtVisitor.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtVisitor</a>&nbsp;visitor)</pre>
<div class="block">Accepts a NBT visitor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - - the hierarchical NBT visitor.</dd>
<dt><span class="strong">Returns:</span></dt><dd>TRUE if the parent should continue processing children at the current level, FALSE otherwise.</dd></dl>
</li>
</ul>
<a name="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtType.html" title="enum in com.comphenix.protocol.wrappers.nbt">NbtType</a>&nbsp;getType()</pre>
<div class="block">Retrieve the type of this NBT element.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The type of this NBT element.</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Retrieve the name of this NBT tag.
<p>
This will be an empty string if the NBT tag is stored in a list.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Name of the tag.</dd></dl>
</li>
</ul>
<a name="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>void&nbsp;setName(java.lang.String&nbsp;name)</pre>
<div class="block">Set the name of this NBT tag.
<p>
This will be ignored if the NBT tag is stored in a list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - name of the tag.</dd></dl>
</li>
</ul>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="type parameter in NbtBase">TType</a>&nbsp;getValue()</pre>
<div class="block">Retrieve the value of this NBT tag.
<p>
Is either a primitive <code>wrapper</code>, <code>String</code>,
<code>List</code> or a <code>Map</code>.
<p>
All operations that modify collections directly, such as <code>List.add(Object)</code> or
<code>Map.clear()</code>, are considered optional. This also include members in <code>Iterator</code> and
<code>ListIterator</code>. Operations that are not implemented throw a
<code>UnsupportedOperationException</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Value of this tag.</dd></dl>
</li>
</ul>
<a name="setValue(java.lang.Object)">
<!-- -->
</a><a name="setValue(TType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void&nbsp;setValue(<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="type parameter in NbtBase">TType</a>&nbsp;newValue)</pre>
<div class="block">Set the value of this NBT tag.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newValue</code> - - the new value of this tag.</dd></dl>
</li>
</ul>
<a name="deepClone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deepClone</h4>
<pre><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a>&lt;<a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="type parameter in NbtBase">TType</a>&gt;&nbsp;deepClone()</pre>
<div class="block">Clone the current NBT tag.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The cloned tag.</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/NbtBase.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>Prev Class</li>
<li><a href="../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.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/NbtBase.html" target="_top">Frames</a></li>
<li><a href="NbtBase.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>