PlotSquared/doc/com/intellectualcrafters/jnbt/NBTUtils.html

349 lines
17 KiB
HTML
Raw Normal View History

2014-11-16 11:14:40 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:55 CET 2014 -->
<title>NBTUtils</title>
<meta name="date" content="2014-11-16">
<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 = "NBTUtils";
}
//-->
</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="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/intellectualcrafters/jnbt/NBTOutputStream.html"
title="class in com.intellectualcrafters.jnbt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/intellectualcrafters/jnbt/ShortTag.html"
title="class in com.intellectualcrafters.jnbt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/intellectualcrafters/jnbt/NBTUtils.html" target="_top">Frames</a></li>
<li><a href="NBTUtils.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.intellectualcrafters.jnbt</div>
<h2 title="Class NBTUtils" class="title">Class NBTUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.jnbt.NBTUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">NBTUtils</span>
extends java.lang.Object</pre>
<div class="block">A class which contains NBT-related utility methods.</div>
</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>static &lt;T extends <a
href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;<br>T</code>
</td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/jnbt/NBTUtils.html#getChildTag(java.util.Map,%20java.lang.String,%20java.lang.Class)">getChildTag</a></strong>(java.util.Map&lt;java.lang.String,<a
href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;items,
java.lang.String&nbsp;key,
java.lang.Class&lt;T&gt;&nbsp;expected)</code>
<div class="block">Get child tag of a NBT structure.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Class&lt;? extends <a
href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/jnbt/NBTUtils.html#getTypeClass(int)">getTypeClass</a></strong>(int&nbsp;type)</code>
<div class="block">Gets the class of a type of tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/jnbt/NBTUtils.html#getTypeCode(java.lang.Class)">getTypeCode</a></strong>(java.lang.Class&lt;?
extends <a href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;clazz)</code>
<div class="block">Gets the type code of a tag class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/jnbt/NBTUtils.html#getTypeName(java.lang.Class)">getTypeName</a></strong>(java.lang.Class&lt;?
extends <a href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;clazz)</code>
<div class="block">Gets the type name of a tag.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait</code></li>
</ul>
</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="getTypeName(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getTypeName(java.lang.Class&lt;? extends <a
href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;clazz)</pre>
<div class="block">Gets the type name of a tag.</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>clazz</code> - the tag class</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>The type name.</dd>
</dl>
</li>
</ul>
<a name="getTypeCode(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeCode</h4>
<pre>public static&nbsp;int&nbsp;getTypeCode(java.lang.Class&lt;? extends <a
href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;clazz)</pre>
<div class="block">Gets the type code of a tag class.</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>clazz</code> - the tag class</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>The type code.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the tag class is invalid.
</dd>
</dl>
</li>
</ul>
<a name="getTypeClass(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeClass</h4>
<pre>public static&nbsp;java.lang.Class&lt;? extends <a
href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;getTypeClass(int&nbsp;type)</pre>
<div class="block">Gets the class of a type of tag.</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>type</code> - the type</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>The class.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the tag type is invalid.
</dd>
</dl>
</li>
</ul>
<a name="getChildTag(java.util.Map, java.lang.String, java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getChildTag</h4>
<pre>public static&nbsp;&lt;T extends <a href="../../../com/intellectualcrafters/jnbt/Tag.html"
title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;T&nbsp;getChildTag(java.util.Map&lt;java.lang.String,<a
href="../../../com/intellectualcrafters/jnbt/Tag.html" title="class in com.intellectualcrafters.jnbt">Tag</a>&gt;&nbsp;items,
java.lang.String&nbsp;key,
java.lang.Class&lt;T&gt;&nbsp;expected)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Get child tag of a NBT structure.</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>items</code> - the map to read from</dd>
<dd><code>key</code> - the key to look for</dd>
<dd><code>expected</code> - the expected NBT class type</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>child tag</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>InvalidFormatException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></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="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/intellectualcrafters/jnbt/NBTOutputStream.html"
title="class in com.intellectualcrafters.jnbt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/intellectualcrafters/jnbt/ShortTag.html"
title="class in com.intellectualcrafters.jnbt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/intellectualcrafters/jnbt/NBTUtils.html" target="_top">Frames</a></li>
<li><a href="NBTUtils.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>