backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/System/IO/BinaryWriter.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

551 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:31 CEST 2013 -->
<title>BinaryWriter</title>
<meta name="date" content="2013-10-15">
<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="BinaryWriter";
}
//-->
</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/BinaryWriter.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="../../System/IO/BinaryReader.html" title="class in System.IO"><span class="strong">Prev Class</span></a></li>
<li><a href="../../System/IO/EndOfStreamException.html" title="class in System.IO"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?System/IO/BinaryWriter.html" target="_top">Frames</a></li>
<li><a href="BinaryWriter.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">System.IO</div>
<h2 title="Class BinaryWriter" class="title">Class BinaryWriter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>System.IO.BinaryWriter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../System/IDisposable.html" title="interface in System">IDisposable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../Microsoft/Xna/Framework/Net/PacketWriter.html" title="class in Microsoft.Xna.Framework.Net">PacketWriter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">BinaryWriter</span>
extends java.lang.Object
implements <a href="../../System/IDisposable.html" title="interface in System">IDisposable</a></pre>
<div class="block">Writes primitive types in binary to a stream and supports writing strings in a specific encoding.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</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="../../System/IO/BinaryWriter.html" title="class in System.IO">BinaryWriter</a></code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Null">Null</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#OutStream">OutStream</a></strong></code>&nbsp;</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#BinaryWriter()">BinaryWriter</a></strong>()</code>
<div class="block">Initializes a new instance of the System.IO.BinaryWriter class that writes to a stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#BinaryWriter(System.IO.Stream)">BinaryWriter</a></strong>(<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;output)</code>
<div class="block">Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and using UTF-8 as the encoding for strings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#BinaryWriter(System.IO.Stream, java.lang.String)">BinaryWriter</a></strong>(<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;output,
java.lang.String&nbsp;encoding)</code>
<div class="block">Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and a specific character encoding.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Close()">Close</a></strong>()</code>
<div class="block">Closes the current System.IO.BinaryWriter and the underlying stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Dispose()">Dispose</a></strong>()</code>
<div class="block">Releases the resources used by the current instance of the System.IO.BinaryWriter class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Dispose(boolean)">Dispose</a></strong>(boolean&nbsp;disposing)</code>
<div class="block">Called by the System.IO.BinaryWriter.Dispose method and finalizer to release the managed and unmanaged resources used by the current instance of the System.IO.BinaryWriter class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Flush()">Flush</a></strong>()</code>
<div class="block">Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a></code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#getBaseStream()">getBaseStream</a></strong>()</code>
<div class="block">Gets the underlying stream of the System.IO.BinaryWriter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(boolean)">Write</a></strong>(boolean&nbsp;value)</code>
<div class="block">Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(byte)">Write</a></strong>(byte&nbsp;value)</code>
<div class="block">Writes a signed byte to the current stream and advances the stream position by one byte.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(byte[])">Write</a></strong>(byte[]&nbsp;buffer)</code>
<div class="block">Writes a byte array to the underlying stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(int)">Write</a></strong>(int&nbsp;value)</code>
<div class="block">Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(long)">Write</a></strong>(long&nbsp;value)</code>
<div class="block">Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(short)">Write</a></strong>(short&nbsp;value)</code>
<div class="block">Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../System/IO/BinaryWriter.html#Write(java.lang.String)">Write</a></strong>(java.lang.String&nbsp;value)</code>
<div class="block">Writes a length-prefixed string to this stream in the current encoding of the System.IO.BinaryWriter, and advances the current position of the stream in accordance with the encoding used and the specific characters being written to the stream.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="Null">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Null</h4>
<pre>public static final&nbsp;<a href="../../System/IO/BinaryWriter.html" title="class in System.IO">BinaryWriter</a> Null</pre>
</li>
</ul>
<a name="OutStream">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OutStream</h4>
<pre>protected&nbsp;<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a> OutStream</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BinaryWriter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BinaryWriter</h4>
<pre>protected&nbsp;BinaryWriter()</pre>
<div class="block">Initializes a new instance of the System.IO.BinaryWriter class that writes to a stream.</div>
</li>
</ul>
<a name="BinaryWriter(System.IO.Stream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BinaryWriter</h4>
<pre>public&nbsp;BinaryWriter(<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;output)</pre>
<div class="block">Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and using UTF-8 as the encoding for strings.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - The output stream.</dd></dl>
</li>
</ul>
<a name="BinaryWriter(System.IO.Stream, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BinaryWriter</h4>
<pre>public&nbsp;BinaryWriter(<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;output,
java.lang.String&nbsp;encoding)</pre>
<div class="block">Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and a specific character encoding.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - The output stream.</dd><dd><code>encoding</code> - The character encoding to use.</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="getBaseStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseStream</h4>
<pre>public&nbsp;<a href="../../System/IO/Stream.html" title="class in System.IO">Stream</a>&nbsp;getBaseStream()</pre>
<div class="block">Gets the underlying stream of the System.IO.BinaryWriter.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The underlying stream associated with the BinaryWriter.</dd></dl>
</li>
</ul>
<a name="Close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Close</h4>
<pre>public&nbsp;void&nbsp;Close()</pre>
<div class="block">Closes the current System.IO.BinaryWriter and the underlying stream.</div>
</li>
</ul>
<a name="Dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>public&nbsp;void&nbsp;Dispose()</pre>
<div class="block">Releases the resources used by the current instance of the System.IO.BinaryWriter class.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../System/IDisposable.html#Dispose()">Dispose</a></code>&nbsp;in interface&nbsp;<code><a href="../../System/IDisposable.html" title="interface in System">IDisposable</a></code></dd>
</dl>
</li>
</ul>
<a name="Dispose(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>protected&nbsp;void&nbsp;Dispose(boolean&nbsp;disposing)</pre>
<div class="block">Called by the System.IO.BinaryWriter.Dispose method and finalizer to release the managed and unmanaged resources used by the current instance of the System.IO.BinaryWriter class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>disposing</code> - true to release managed and unmanaged resources; false to release only unmanaged resources.</dd></dl>
</li>
</ul>
<a name="Flush()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Flush</h4>
<pre>public&nbsp;void&nbsp;Flush()</pre>
<div class="block">Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.</div>
</li>
</ul>
<a name="Write(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(boolean&nbsp;value)</pre>
<div class="block">Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Boolean value to write (0 or 1).</dd></dl>
</li>
</ul>
<a name="Write(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(byte&nbsp;value)</pre>
<div class="block">Writes a signed byte to the current stream and advances the stream position by one byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The signed byte to write.</dd></dl>
</li>
</ul>
<a name="Write(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(byte[]&nbsp;buffer)</pre>
<div class="block">Writes a byte array to the underlying stream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - A byte array containing the data to write.</dd></dl>
</li>
</ul>
<a name="Write(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(short&nbsp;value)</pre>
<div class="block">Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The two-byte signed integer to write.</dd></dl>
</li>
</ul>
<a name="Write(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(int&nbsp;value)</pre>
<div class="block">Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The four-byte signed integer to write.</dd></dl>
</li>
</ul>
<a name="Write(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(long&nbsp;value)</pre>
<div class="block">Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The eight-byte signed integer to write.</dd></dl>
</li>
</ul>
<a name="Write(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Write</h4>
<pre>public&nbsp;void&nbsp;Write(java.lang.String&nbsp;value)</pre>
<div class="block">Writes a length-prefixed string to this stream in the current encoding of the System.IO.BinaryWriter, and advances the current position of the stream in accordance with the encoding used and the specific characters being written to the stream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The value to write.</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/BinaryWriter.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="../../System/IO/BinaryReader.html" title="class in System.IO"><span class="strong">Prev Class</span></a></li>
<li><a href="../../System/IO/EndOfStreamException.html" title="class in System.IO"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?System/IO/BinaryWriter.html" target="_top">Frames</a></li>
<li><a href="BinaryWriter.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>
Reference in New Issue View Git Blame Copy Permalink