System.IO

Class BinaryWriter

java.lang.Object

System.IO.BinaryWriter

All Implemented Interfaces:

IDisposable

Direct Known Subclasses:

PacketWriter

public class BinaryWriter
extends java.lang.Object
implements IDisposable

Writes primitive types in binary to a stream and supports writing strings in a specific encoding.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
static BinaryWriter	Null
protected Stream	OutStream

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BinaryWriter() Initializes a new instance of the System.IO.BinaryWriter class that writes to a stream.
	BinaryWriter(Stream output) Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and using UTF-8 as the encoding for strings.
	BinaryWriter(Stream output, java.lang.String encoding) Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and a specific character encoding.

Method Summary

Methods

Modifier and Type	Method and Description
void	Close() Closes the current System.IO.BinaryWriter and the underlying stream.
void	Dispose() Releases the resources used by the current instance of the System.IO.BinaryWriter class.
protected void	Dispose(boolean disposing) 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.
void	Flush() Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Stream	getBaseStream() Gets the underlying stream of the System.IO.BinaryWriter.
void	Write(boolean value) Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.
void	Write(byte value) Writes a signed byte to the current stream and advances the stream position by one byte.
void	Write(byte[] buffer) Writes a byte array to the underlying stream.
void	Write(int value) Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.
void	Write(long value) Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes.
void	Write(short value) Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.
void	Write(java.lang.String value) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Null

public static final BinaryWriter Null

OutStream

protected Stream OutStream

Constructor Detail

BinaryWriter

protected BinaryWriter()

Initializes a new instance of the System.IO.BinaryWriter class that writes to a stream.

BinaryWriter

public BinaryWriter(Stream output)

Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and using UTF-8 as the encoding for strings.

Parameters:

output - The output stream.

BinaryWriter

public BinaryWriter(Stream output,
            java.lang.String encoding)

Initializes a new instance of the System.IO.BinaryWriter class based on the supplied stream and a specific character encoding.

Parameters:

output - The output stream.

encoding - The character encoding to use.

Method Detail

getBaseStream

public Stream getBaseStream()

Gets the underlying stream of the System.IO.BinaryWriter.

Returns:

The underlying stream associated with the BinaryWriter.

Close

public void Close()

Closes the current System.IO.BinaryWriter and the underlying stream.

Dispose

public void Dispose()

Releases the resources used by the current instance of the System.IO.BinaryWriter class.

Specified by:

Dispose in interface IDisposable

Dispose

protected void Dispose(boolean disposing)

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.

Parameters:

disposing - true to release managed and unmanaged resources; false to release only unmanaged resources.

Flush

public void Flush()

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

Write

public void Write(boolean value)

Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.

Parameters:

value - The Boolean value to write (0 or 1).

Write

public void Write(byte value)

Writes a signed byte to the current stream and advances the stream position by one byte.

Parameters:

value - The signed byte to write.

Write

public void Write(byte[] buffer)

Writes a byte array to the underlying stream.

Parameters:

buffer - A byte array containing the data to write.

Write

public void Write(short value)

Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.

Parameters:

value - The two-byte signed integer to write.

Write

public void Write(int value)

Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.

Parameters:

value - The four-byte signed integer to write.

Write

public void Write(long value)

Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes.

Parameters:

value - The eight-byte signed integer to write.

Write

public void Write(java.lang.String value)

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.

Parameters:

value - The value to write.