Top Description Fields Constructors Methods
org.jboss.marshalling

public Class SimpleDataOutput

extends ByteOutputStream
implements DataOutput
Class Inheritance
All Implemented Interfaces
java.io.DataOutput
Known Direct Subclasses
org.jboss.marshalling.AbstractObjectOutput
Imports
java.io.DataOutput, .IOException, .NotActiveException
A simple base implementation of DataOutput which wraps a ByteOutput. This implementation maintains an internal buffer.

Field Summary

Modifier and TypeField and Description
protected byte[]
buffer

The internal buffer.

protected final int
bufferSize

The size of the internal buffer.

private int
position

The position in the buffer.

Inherited from org.jboss.marshalling.ByteOutputStream:
byteOutput

Constructor Summary

AccessConstructor and Description
public
SimpleDataOutput(final int
the buffer size
bufferSize)

Construct a new instance.

public
SimpleDataOutput(final int
the buffer size
bufferSize, final ByteOutput
the byte output to wrap
byteOutput)

Construct a new instance.

public
SimpleDataOutput(final ByteOutput
the byte output to wrap
byteOutput)

Construct a new instance with a default buffer size.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides org.jboss.marshalling.ByteOutputStream.close.

Implements java.io.Closeable.close.

Closes this stream and releases any system resources associated with it.
protected void
finish()

Finish writing to a stream.

public void
flush()

Overrides org.jboss.marshalling.ByteOutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this stream by writing any buffered output to the underlying stream.
private static NotActiveException
notActiveException()

protected void
shallowFlush()

This shallow flush will write the internal buffer out to the ByteOutput, but will not flush it.

protected void
start(ByteOutput
the new stream
byteOutput)

Begin writing to a stream.

public void
write(final int
the byte to be written.
v)

Overrides org.jboss.marshalling.ByteOutputStream.write.

Implements java.io.DataOutput.write, org.jboss.marshalling.ByteOutput.write.

Writes to the output stream the eight low-order bits of the argument b.
public void
write(final byte[]
the data.
bytes)

Overrides org.jboss.marshalling.ByteOutputStream.write.

Implements java.io.DataOutput.write, org.jboss.marshalling.ByteOutput.write.

Writes to the output stream all the bytes in array b.
public void
write(final byte[]
the data.
bytes, final int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides org.jboss.marshalling.ByteOutputStream.write.

Implements java.io.DataOutput.write, org.jboss.marshalling.ByteOutput.write.

Writes len bytes from array b, in order, to the output stream.
public void
writeBoolean(final boolean
the boolean to be written.
v)

Implements java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream.
public void
writeByte(final int
the byte value to be written.
v)

Implements java.io.DataOutput.writeByte.

Writes to the output stream the eight low-order bits of the argument v.
public void
writeBytes(final String
the string of bytes to be written.
s)

Implements java.io.DataOutput.writeBytes.

Writes a string to the output stream.
public void
writeChar(final int
the char value to be written.
v)

Implements java.io.DataOutput.writeChar.

Writes a char value, which is comprised of two bytes, to the output stream.
public void
writeChars(final String
the string value to be written.
s)

Implements java.io.DataOutput.writeChars.

Writes every character in the string s, to the output stream, in order, two bytes per character.
public void
writeDouble(final double
the double value to be written.
v)

Implements java.io.DataOutput.writeDouble.

Writes a double value, which is comprised of eight bytes, to the output stream.
public void
writeFloat(final float
the float value to be written.
v)

Implements java.io.DataOutput.writeFloat.

Writes a float value, which is comprised of four bytes, to the output stream.
public void
writeInt(final int
the int value to be written.
v)

Implements java.io.DataOutput.writeInt.

Writes an int value, which is comprised of four bytes, to the output stream.
public void
writeLong(final long
the long value to be written.
v)

Implements java.io.DataOutput.writeLong.

Writes a long value, which is comprised of eight bytes, to the output stream.
public void
writeShort(final int
the short value to be written.
v)

Implements java.io.DataOutput.writeShort.

Writes two bytes to the output stream to represent the value of the argument.
public void
writeUTF(final String
the string value to be written.
s)

Implements java.io.DataOutput.writeUTF.

Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s.

Field Detail

bufferback to summary
protected byte[] buffer

The internal buffer.

bufferSizeback to summary
protected final int bufferSize

The size of the internal buffer.

positionback to summary
private int position

The position in the buffer.

Constructor Detail

SimpleDataOutputback to summary
public SimpleDataOutput(final int bufferSize)

Construct a new instance.

Parameters
bufferSize:int

the buffer size

SimpleDataOutputback to summary
public SimpleDataOutput(final int bufferSize, final ByteOutput byteOutput)

Construct a new instance.

Parameters
bufferSize:int

the buffer size

byteOutput:ByteOutput

the byte output to wrap

SimpleDataOutputback to summary
public SimpleDataOutput(final ByteOutput byteOutput)

Construct a new instance with a default buffer size.

Parameters
byteOutput:ByteOutput

the byte output to wrap

Method Detail

closeback to summary
public void close() throws IOException

Overrides org.jboss.marshalling.ByteOutputStream.close.

Implements java.io.Closeable.close.

Doc from org.jboss.marshalling.ByteOutputStream.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Exceptions
IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

finishback to summary
protected void finish() throws IOException

Finish writing to a stream. The stream is released. No further writing may be done until the start(ByteOutput) method is again invoked.

Exceptions
IOException:
if an error occurs
flushback to summary
public void flush() throws IOException

Overrides org.jboss.marshalling.ByteOutputStream.flush.

Implements java.io.Flushable.flush.

Doc from org.jboss.marshalling.ByteOutputStream.flush.

Flushes this stream by writing any buffered output to the underlying stream.

Exceptions
IOException:

Doc from java.io.Flushable.flush.

If an I/O error occurs

notActiveExceptionback to summary
private static NotActiveException notActiveException()
shallowFlushback to summary
protected void shallowFlush() throws IOException

This shallow flush will write the internal buffer out to the ByteOutput, but will not flush it.

Exceptions
IOException:
if an I/O error occurs
startback to summary
protected void start(ByteOutput byteOutput) throws IOException

Begin writing to a stream.

Parameters
byteOutput:ByteOutput

the new stream

Exceptions
IOException:
if an error occurs
writeback to summary
public void write(final int v) throws IOException

Overrides org.jboss.marshalling.ByteOutputStream.write.

Implements java.io.DataOutput.write, org.jboss.marshalling.ByteOutput.write.

Doc from java.io.DataOutput.write.

Writes to the output stream the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
v:int

the byte to be written.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(final byte[] bytes) throws IOException

Overrides org.jboss.marshalling.ByteOutputStream.write.

Implements java.io.DataOutput.write, org.jboss.marshalling.ByteOutput.write.

Doc from java.io.DataOutput.write.

Writes to the output stream all the bytes in array b. If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are written. Otherwise, the byte b[0] is written first, then b[1], and so on; the last byte written is b[b.length-1].

Parameters
bytes:byte[]

the data.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(final byte[] bytes, final int off, int len) throws IOException

Overrides org.jboss.marshalling.ByteOutputStream.write.

Implements java.io.DataOutput.write, org.jboss.marshalling.ByteOutput.write.

Doc from java.io.DataOutput.write.

Writes len bytes from array b, in order, to the output stream. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are written. Otherwise, the byte b[off] is written first, then b[off+1], and so on; the last byte written is b[off+len-1].

Parameters
bytes:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs.
writeBooleanback to summary
public void writeBoolean(final boolean v) throws IOException

Implements java.io.DataOutput.writeBoolean.

Doc from java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream. If the argument v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. The byte written by this method may be read by the readBoolean method of interface DataInput, which will then return a boolean equal to v.

Parameters
v:boolean

the boolean to be written.

Exceptions
IOException:
if an I/O error occurs.
writeByteback to summary
public void writeByte(final int v) throws IOException

Implements java.io.DataOutput.writeByte.

Doc from java.io.DataOutput.writeByte.

Writes to the output stream the eight low-order bits of the argument v. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) The byte written by this method may be read by the readByte method of interface DataInput, which will then return a byte equal to (byte)v.

Parameters
v:int

the byte value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeBytesback to summary
public void writeBytes(final String s) throws IOException

Implements java.io.DataOutput.writeBytes.

Doc from java.io.DataOutput.writeBytes.

Writes a string to the output stream. For every character in the string s, taken in order, one byte is written to the output stream. If s is null, a NullPointerException is thrown.

If s.length is zero, then no bytes are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, one byte is written, the low-order byte, in exactly the manner of the writeByte method . The high-order eight bits of each character in the string are ignored.

Parameters
s:String

the string of bytes to be written.

Exceptions
IOException:
if an I/O error occurs.
writeCharback to summary
public void writeChar(final int v) throws IOException

Implements java.io.DataOutput.writeChar.

Doc from java.io.DataOutput.writeChar.

Writes a char value, which is comprised of two bytes, to the output stream. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 8))
(byte)(0xff & v)

The bytes written by this method may be read by the readChar method of interface DataInput, which will then return a char equal to (char)v.

Parameters
v:int

the char value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeCharsback to summary
public void writeChars(final String s) throws IOException

Implements java.io.DataOutput.writeChars.

Doc from java.io.DataOutput.writeChars.

Writes every character in the string s, to the output stream, in order, two bytes per character. If s is null, a NullPointerException is thrown. If s.length is zero, then no characters are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, two bytes are actually written, high-order byte first, in exactly the manner of the writeChar method.

Parameters
s:String

the string value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeDoubleback to summary
public void writeDouble(final double v) throws IOException

Implements java.io.DataOutput.writeDouble.

Doc from java.io.DataOutput.writeDouble.

Writes a double value, which is comprised of eight bytes, to the output stream. It does this as if it first converts this double value to a long in exactly the manner of the Double.doubleToLongBits method and then writes the long value in exactly the manner of the writeLong method. The bytes written by this method may be read by the readDouble method of interface DataInput, which will then return a double equal to v.

Parameters
v:double

the double value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeFloatback to summary
public void writeFloat(final float v) throws IOException

Implements java.io.DataOutput.writeFloat.

Doc from java.io.DataOutput.writeFloat.

Writes a float value, which is comprised of four bytes, to the output stream. It does this as if it first converts this float value to an int in exactly the manner of the Float.floatToIntBits method and then writes the int value in exactly the manner of the writeInt method. The bytes written by this method may be read by the readFloat method of interface DataInput, which will then return a float equal to v.

Parameters
v:float

the float value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeIntback to summary
public void writeInt(final int v) throws IOException

Implements java.io.DataOutput.writeInt.

Doc from java.io.DataOutput.writeInt.

Writes an int value, which is comprised of four bytes, to the output stream. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 24))
(byte)(0xff & (v >> 16))
(byte)(0xff & (v >>  8))
(byte)(0xff & v)

The bytes written by this method may be read by the readInt method of interface DataInput, which will then return an int equal to v.

Parameters
v:int

the int value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeLongback to summary
public void writeLong(final long v) throws IOException

Implements java.io.DataOutput.writeLong.

Doc from java.io.DataOutput.writeLong.

Writes a long value, which is comprised of eight bytes, to the output stream. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 56))
(byte)(0xff & (v >> 48))
(byte)(0xff & (v >> 40))
(byte)(0xff & (v >> 32))
(byte)(0xff & (v >> 24))
(byte)(0xff & (v >> 16))
(byte)(0xff & (v >>  8))
(byte)(0xff & v)

The bytes written by this method may be read by the readLong method of interface DataInput, which will then return a long equal to v.

Parameters
v:long

the long value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeShortback to summary
public void writeShort(final int v) throws IOException

Implements java.io.DataOutput.writeShort.

Doc from java.io.DataOutput.writeShort.

Writes two bytes to the output stream to represent the value of the argument. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 8))
(byte)(0xff & v)

The bytes written by this method may be read by the readShort method of interface DataInput, which will then return a short equal to (short)v.

Parameters
v:int

the short value to be written.

Exceptions
IOException:
if an I/O error occurs.
writeUTFback to summary
public void writeUTF(final String s) throws IOException

Implements java.io.DataOutput.writeUTF.

Doc from java.io.DataOutput.writeUTF.

Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s. If s is null, a NullPointerException is thrown. Each character in the string s is converted to a group of one, two, or three bytes, depending on the value of the character.

If a character c is in the range \u0001 through \u007f, it is represented by one byte: 

(byte)c

If a character c is \u0000 or is in the range \u0080 through \u07ff, then it is represented by two bytes, to be written in the order shown: 

(byte)(0xc0 | (0x1f & (c >> 6)))
(byte)(0x80 | (0x3f & c))

If a character c is in the range \u0800 through uffff, then it is represented by three bytes, to be written in the order shown: 

(byte)(0xe0 | (0x0f & (c >> 12)))
(byte)(0x80 | (0x3f & (c >>  6)))
(byte)(0x80 | (0x3f & c))

First, the total number of bytes needed to represent all the characters of s is calculated. If this number is larger than 65535, then a UTFDataFormatException is thrown. Otherwise, this length is written to the output stream in exactly the manner of the writeShort method; after this, the one-, two-, or three-byte representation of each character in the string s is written.

The bytes written by this method may be read by the readUTF method of interface DataInput, which will then return a String equal to s.

Parameters
s:String

the string value to be written.

Exceptions
IOException:
if an I/O error occurs.