SteamWar/ProtocolLib
Archiviert
13
0
Fork 0
Code Issues Pull-Requests Releases Wiki Aktivität
Dieses Repository wurde am 2021-01-06 archiviert. Du kannst Dateien ansehen und es klonen, aber nicht pushen oder Issues/Pull-Requests öffnen.
a6755d0ddd
ProtocolLib/Javadoc/com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html

436 Zeilen
20 KiB
HTML
Originalformat Normale Ansicht Verlauf

Updated JavaDoc for 2.0.0
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>NbtConfigurationSerializer</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="NbtConfigurationSerializer";
}
//-->
</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/NbtConfigurationSerializer.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/NbtBinarySerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html" target="_top">Frames</a></li>
<li><a href="NbtConfigurationSerializer.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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.io</div>
<h2 title="Class NbtConfigurationSerializer" class="title">Class NbtConfigurationSerializer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.wrappers.nbt.io.NbtConfigurationSerializer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">NbtConfigurationSerializer</span>
extends java.lang.Object</pre>
<div class="block">Serialize and deserialize NBT information from a configuration section.
<p>
Note that data types may be internally preserved by modifying the serialized name. This may
be visible to the end-user.</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">&nbsp;</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/NbtConfigurationSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtConfigurationSerializer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#DEFAULT">DEFAULT</a></strong></code>
<div class="block">A standard YAML serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#TYPE_DELIMITER">TYPE_DELIMITER</a></strong></code>
<div class="block">The default delimiter that is used to store the data type in YAML.</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">&nbsp;</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/NbtConfigurationSerializer.html#NbtConfigurationSerializer()">NbtConfigurationSerializer</a></strong>()</code>
<div class="block">Construct a serializer using <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#TYPE_DELIMITER"><code>TYPE_DELIMITER</code></a> as the default delimiter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#NbtConfigurationSerializer(java.lang.String)">NbtConfigurationSerializer</a></strong>(java.lang.String&nbsp;dataTypeDelimiter)</code>
<div class="block">Construct a serializer using the given value as a delimiter.</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">&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>&lt;TType&gt;&nbsp;<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtWrapper</a>&lt;TType&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#deserialize(org.bukkit.configuration.ConfigurationSection, java.lang.String)">deserialize</a></strong>(org.bukkit.configuration.ConfigurationSection&nbsp;root,
java.lang.String&nbsp;nodeName)</code>
<div class="block">Read a NBT tag from a root configuration.</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/NbtConfigurationSerializer.html#deserializeCompound(org.bukkit.configuration.file.YamlConfiguration, java.lang.String)">deserializeCompound</a></strong>(org.bukkit.configuration.file.YamlConfiguration&nbsp;root,
java.lang.String&nbsp;nodeName)</code>
<div class="block">Read a NBT compound from a root configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;T&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#deserializeList(org.bukkit.configuration.file.YamlConfiguration, java.lang.String)">deserializeList</a></strong>(org.bukkit.configuration.file.YamlConfiguration&nbsp;root,
java.lang.String&nbsp;nodeName)</code>
<div class="block">Read a NBT compound from a root configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#getDataTypeDelimiter()">getDataTypeDelimiter</a></strong>()</code>
<div class="block">Retrieve the current data type delimiter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;TType&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#serialize(com.comphenix.protocol.wrappers.nbt.NbtBase, org.bukkit.configuration.ConfigurationSection)">serialize</a></strong>(<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a>&lt;TType&gt;&nbsp;value,
org.bukkit.configuration.ConfigurationSection&nbsp;destination)</code>
<div class="block">Write the content of a NBT tag to a configuration section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#toNodeValue(java.lang.Object, com.comphenix.protocol.wrappers.nbt.NbtType)">toNodeValue</a></strong>(java.lang.Object&nbsp;value,
<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtType.html" title="enum in com.comphenix.protocol.wrappers.nbt">NbtType</a>&nbsp;type)</code>&nbsp;</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TYPE_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_DELIMITER</h4>
<pre>public static final&nbsp;java.lang.String TYPE_DELIMITER</pre>
<div class="block">The default delimiter that is used to store the data type in YAML.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#com.comphenix.protocol.wrappers.nbt.io.NbtConfigurationSerializer.TYPE_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final&nbsp;<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io">NbtConfigurationSerializer</a> DEFAULT</pre>
<div class="block">A standard YAML 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="NbtConfigurationSerializer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NbtConfigurationSerializer</h4>
<pre>public&nbsp;NbtConfigurationSerializer()</pre>
<div class="block">Construct a serializer using <a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html#TYPE_DELIMITER"><code>TYPE_DELIMITER</code></a> as the default delimiter.</div>
</li>
</ul>
<a name="NbtConfigurationSerializer(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NbtConfigurationSerializer</h4>
<pre>public&nbsp;NbtConfigurationSerializer(java.lang.String&nbsp;dataTypeDelimiter)</pre>
<div class="block">Construct a serializer using the given value as a delimiter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataTypeDelimiter</code> - - the local data type delimiter.</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="getDataTypeDelimiter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataTypeDelimiter</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDataTypeDelimiter()</pre>
<div class="block">Retrieve the current data type delimiter.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current data type delimiter.</dd></dl>
</li>
</ul>
<a name="serialize(com.comphenix.protocol.wrappers.nbt.NbtBase, org.bukkit.configuration.ConfigurationSection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public&nbsp;&lt;TType&gt;&nbsp;void&nbsp;serialize(<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtBase.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtBase</a>&lt;TType&gt;&nbsp;value,
org.bukkit.configuration.ConfigurationSection&nbsp;destination)</pre>
<div class="block">Write the content of a NBT tag to a configuration section.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - - the NBT tag to write.</dd><dd><code>destination</code> - - the destination section.</dd></dl>
</li>
</ul>
<a name="deserialize(org.bukkit.configuration.ConfigurationSection, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserialize</h4>
<pre>public&nbsp;&lt;TType&gt;&nbsp;<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtWrapper.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtWrapper</a>&lt;TType&gt;&nbsp;deserialize(org.bukkit.configuration.ConfigurationSection&nbsp;root,
java.lang.String&nbsp;nodeName)</pre>
<div class="block">Read a NBT tag from a root configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - - configuration that contains the NBT tag.</dd><dd><code>nodeName</code> - - name of the NBT tag.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The read NBT tag.</dd></dl>
</li>
</ul>
<a name="deserializeCompound(org.bukkit.configuration.file.YamlConfiguration, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeCompound</h4>
<pre>public&nbsp;<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtCompound.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtCompound</a>&nbsp;deserializeCompound(org.bukkit.configuration.file.YamlConfiguration&nbsp;root,
java.lang.String&nbsp;nodeName)</pre>
<div class="block">Read a NBT compound from a root configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - - configuration that contains the NBT compound.</dd><dd><code>nodeName</code> - - name of the NBT compound.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The read NBT compound.</dd></dl>
</li>
</ul>
<a name="deserializeList(org.bukkit.configuration.file.YamlConfiguration, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeList</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtList.html" title="interface in com.comphenix.protocol.wrappers.nbt">NbtList</a>&lt;T&gt;&nbsp;deserializeList(org.bukkit.configuration.file.YamlConfiguration&nbsp;root,
java.lang.String&nbsp;nodeName)</pre>
<div class="block">Read a NBT compound from a root configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - - configuration that contains the NBT compound.</dd><dd><code>nodeName</code> - - name of the NBT compound.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The read NBT compound.</dd></dl>
</li>
</ul>
<a name="toNodeValue(java.lang.Object, com.comphenix.protocol.wrappers.nbt.NbtType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toNodeValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;toNodeValue(java.lang.Object&nbsp;value,
<a href="../../../../../../com/comphenix/protocol/wrappers/nbt/NbtType.html" title="enum in com.comphenix.protocol.wrappers.nbt">NbtType</a>&nbsp;type)</pre>
</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/NbtConfigurationSerializer.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/NbtBinarySerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../com/comphenix/protocol/wrappers/nbt/io/NbtTextSerializer.html" title="class in com.comphenix.protocol.wrappers.nbt.io"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/comphenix/protocol/wrappers/nbt/io/NbtConfigurationSerializer.html" target="_top">Frames</a></li>
<li><a href="NbtConfigurationSerializer.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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>
In neuem Issue referenzieren Permalink kopieren