345 Zeilen
13 KiB
HTML
345 Zeilen
13 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_21) on Tue May 14 01:28:32 CEST 2013 -->
|
|
<title>StreamSerializer</title>
|
|
<meta name="date" content="2013-05-14">
|
|
<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="StreamSerializer";
|
|
}
|
|
//-->
|
|
</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/StreamSerializer.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/utility/MinecraftVersion.html" title="class in com.comphenix.protocol.utility"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/comphenix/protocol/utility/WrappedScheduler.html" title="class in com.comphenix.protocol.utility"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/utility/StreamSerializer.html" target="_top">Frames</a></li>
|
|
<li><a href="StreamSerializer.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>Field | </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>Field | </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.utility</div>
|
|
<h2 title="Class StreamSerializer" class="title">Class StreamSerializer</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.comphenix.protocol.utility.StreamSerializer</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">StreamSerializer</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Utility methods for reading and writing Minecraft objects to streams.</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">
|
|
<!-- ======== 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/utility/StreamSerializer.html#StreamSerializer()">StreamSerializer</a></strong>()</code> </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>org.bukkit.inventory.ItemStack</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/utility/StreamSerializer.html#deserializeItemStack(java.io.DataInputStream)">deserializeItemStack</a></strong>(java.io.DataInputStream input)</code>
|
|
<div class="block">Read or deserialize an item stack from an underlying input stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>org.bukkit.inventory.ItemStack</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/utility/StreamSerializer.html#deserializeItemStack(java.lang.String)">deserializeItemStack</a></strong>(java.lang.String input)</code>
|
|
<div class="block">Deserialize an item stack from a base-64 encoded string.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/utility/StreamSerializer.html#serializeItemStack(java.io.DataOutputStream, org.bukkit.inventory.ItemStack)">serializeItemStack</a></strong>(java.io.DataOutputStream output,
|
|
org.bukkit.inventory.ItemStack stack)</code>
|
|
<div class="block">Write or serialize an item stack to the given output stream.</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/utility/StreamSerializer.html#serializeItemStack(org.bukkit.inventory.ItemStack)">serializeItemStack</a></strong>(org.bukkit.inventory.ItemStack stack)</code>
|
|
<div class="block">Serialize an item stack as 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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="StreamSerializer()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>StreamSerializer</h4>
|
|
<pre>public StreamSerializer()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="deserializeItemStack(java.io.DataInputStream)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>deserializeItemStack</h4>
|
|
<pre>public org.bukkit.inventory.ItemStack deserializeItemStack(@Nonnull
|
|
java.io.DataInputStream input)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Read or deserialize an item stack from an underlying input stream.
|
|
<p>
|
|
To supply a byte array, wrap it in a <code>ByteArrayInputStream</code>
|
|
and <code>DataInputStream</code>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - - the target input stream.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The resulting item stack, or NULL if the serialized item stack was NULL.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If the operation failed due to reflection or corrupt data.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="deserializeItemStack(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>deserializeItemStack</h4>
|
|
<pre>public org.bukkit.inventory.ItemStack deserializeItemStack(@Nonnull
|
|
java.lang.String input)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Deserialize an item stack from a base-64 encoded string.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - - base-64 encoded string.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>A deserialized item stack, or NULL if the serialized ItemStack was also NULL.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If the operation failed due to reflection or corrupt data.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="serializeItemStack(java.io.DataOutputStream, org.bukkit.inventory.ItemStack)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>serializeItemStack</h4>
|
|
<pre>public void serializeItemStack(@Nonnull
|
|
java.io.DataOutputStream output,
|
|
org.bukkit.inventory.ItemStack stack)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Write or serialize an item stack to the given output stream.
|
|
<p>
|
|
To supply a byte array, wrap it in a <code>ByteArrayOutputStream</code>
|
|
and <code>DataOutputStream</code>.
|
|
<p>
|
|
Note: An ItemStack can be written to a stream even if it's NULL.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - - the target output stream.</dd><dd><code>stack</code> - - the item stack that will be written, or NULL to represent air/nothing.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If the operation fails due to reflection problems.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="serializeItemStack(org.bukkit.inventory.ItemStack)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>serializeItemStack</h4>
|
|
<pre>public java.lang.String serializeItemStack(org.bukkit.inventory.ItemStack stack)
|
|
throws java.io.IOException</pre>
|
|
<div class="block">Serialize an item stack as a base-64 encoded string.
|
|
<p>
|
|
Note: An ItemStack can be written to the serialized text even if it's NULL.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stack</code> - - the item stack to serialize, or NULL to represent air/nothing.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>A base-64 representation of the given item stack.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code>java.io.IOException</code> - If the operation fails due to reflection problems.</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/StreamSerializer.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/utility/MinecraftVersion.html" title="class in com.comphenix.protocol.utility"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/comphenix/protocol/utility/WrappedScheduler.html" title="class in com.comphenix.protocol.utility"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/utility/StreamSerializer.html" target="_top">Frames</a></li>
|
|
<li><a href="StreamSerializer.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>Field | </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>Field | </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>
|