mirror of
https://github.com/dmulloy2/ProtocolLib.git
synced 2024-12-05 00:54:04 +01:00
400 lines
17 KiB
HTML
400 lines
17 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_07) on Thu Jan 10 00:56:14 CET 2013 -->
|
|
<title>NbtTextSerializer</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="NbtTextSerializer";
|
|
}
|
|
//-->
|
|
</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/NbtTextSerializer.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/io/NbtConfigurationSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io"><span class="strong">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../index.html?com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html" target="_top">Frames</a></li>
|
|
<li><a href="NbtTextSerializer.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: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field_summary">Field</a> | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field_detail">Field</a> | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </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.io</div>
|
|
<h2 title="Class NbtTextSerializer" class="title">Class NbtTextSerializer</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.comphenix.protocol.wrappers.nbt.io.NbtTextSerializer</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">NbtTextSerializer</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Serializes NBT to a base-64 encoded string and back.</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">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Field and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtTextSerializer</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#DEFAULT">DEFAULT</a></strong></code>
|
|
<div class="block">A default instance of this serializer.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#NbtTextSerializer()">NbtTextSerializer</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#NbtTextSerializer(com.comphenix.protocol.wrappers.nbt.io.NbtBinarySerializer)">NbtTextSerializer</a></strong>(<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtBinarySerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtBinarySerializer</a> binary)</code>
|
|
<div class="block">Construct a serializer with a custom binary serializer.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== 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"> </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><TType> <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtWrapper</a><TType></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#deserialize(java.lang.String)">deserialize</a></strong>(java.lang.String input)</code>
|
|
<div class="block">Deserialize a NBT tag from a base-64 encoded string.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#deserializeCompound(java.lang.String)">deserializeCompound</a></strong>(java.lang.String input)</code>
|
|
<div class="block">Deserialize a NBT compound from a base-64 encoded string.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><T> <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a><T></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#deserializeList(java.lang.String)">deserializeList</a></strong>(java.lang.String input)</code>
|
|
<div class="block">Deserialize a NBT list from a base-64 encoded string.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtBinarySerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtBinarySerializer</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#getBinarySerializer()">getBinarySerializer</a></strong>()</code>
|
|
<div class="block">Retrieve the binary serializer that is used.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><TType> java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html#serialize(com.comphenix.protocol.wrappers.nbt.NbtBase)">serialize</a></strong>(<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a><TType> value)</code>
|
|
<div class="block">Serialize a NBT tag to a base-64 encoded string.</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 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">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="DEFAULT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>DEFAULT</h4>
|
|
<pre>public static final <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtTextSerializer</a> DEFAULT</pre>
|
|
<div class="block">A default instance of this serializer.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="NbtTextSerializer()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>NbtTextSerializer</h4>
|
|
<pre>public NbtTextSerializer()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="NbtTextSerializer(com.comphenix.protocol.wrappers.nbt.io.NbtBinarySerializer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>NbtTextSerializer</h4>
|
|
<pre>public NbtTextSerializer(<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtBinarySerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtBinarySerializer</a> binary)</pre>
|
|
<div class="block">Construct a serializer with a custom binary serializer.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binary</code> - - binary serializer.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getBinarySerializer()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBinarySerializer</h4>
|
|
<pre>public <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtBinarySerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtBinarySerializer</a> getBinarySerializer()</pre>
|
|
<div class="block">Retrieve the binary serializer that is used.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>The binary serializer.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="serialize(com.comphenix.protocol.wrappers.nbt.NbtBase)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>serialize</h4>
|
|
<pre>public <TType> java.lang.String serialize(<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a><TType> value)</pre>
|
|
<div class="block">Serialize a NBT tag to a base-64 encoded string.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - - the NBT tag to serialize.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The NBT tag in base-64 form.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="deserialize(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>deserialize</h4>
|
|
<pre>public <TType> <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtWrapper</a><TType> deserialize(java.lang.String input)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Deserialize a NBT tag from a base-64 encoded string.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - - the base-64 string.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The NBT tag contained in the string.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If we are unable to parse the input.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="deserializeCompound(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>deserializeCompound</h4>
|
|
<pre>public <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a> deserializeCompound(java.lang.String input)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Deserialize a NBT compound from a base-64 encoded string.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - - the base-64 string.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The NBT tag contained in the string.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If we are unable to parse the input.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="deserializeList(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>deserializeList</h4>
|
|
<pre>public <T> <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a><T> deserializeList(java.lang.String input)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Deserialize a NBT list from a base-64 encoded string.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - - the base-64 string.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The NBT tag contained in the string.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If we are unable to parse the input.</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/NbtTextSerializer.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/io/NbtConfigurationSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io"><span class="strong">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../index.html?com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html" target="_top">Frames</a></li>
|
|
<li><a href="NbtTextSerializer.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: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field_summary">Field</a> | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field_detail">Field</a> | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|