JBoss Marshalling API 2.1.4.Final · org.jboss.marshalling.MarshallerObjectOutput

Modifier and Type	Field and Description
private final Marshaller	marshaller

Access	Constructor and Description
public	MarshallerObjectOutput(final Marshaller the marshaller to delegate to marshaller) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.ObjectOutput.close. Closes the stream.
public void	flush() Implements java.io.ObjectOutput.flush. Flushes the stream.
public void	write(final int the byte b) Implements java.io.ObjectOutput.write. Writes a byte.
public void	write(final byte[] the data to be written b) Implements java.io.ObjectOutput.write. Writes an array of bytes.
public void	write(final byte[] the data to be written b, final int the start offset in the data off, final int the number of bytes that are written len) Implements java.io.ObjectOutput.write. Writes a sub array of bytes.
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	writeObject(final Object the object to be written obj) Implements java.io.ObjectOutput.writeObject. Write an object to the underlying storage or 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`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

marshaller	back to summary
private final Marshaller marshaller

MarshallerObjectOutput	back to summary
public MarshallerObjectOutput(final Marshaller marshaller) Construct a new instance. Parameters marshaller:Marshaller the marshaller to delegate to

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.ObjectOutput.close. Doc from java.io.ObjectOutput.close. Closes the stream. This method must be called to release any resources associated with the stream. This implementation always throws an `IllegalStateException`. Exceptions IOException: If an I/O error has occurred.

public void close() throws IOException

Implements java.io.ObjectOutput.close.

Doc from java.io.ObjectOutput.close.

Closes the stream. This method must be called to release any resources associated with the stream. This implementation always throws an IllegalStateException.

Exceptions

IOException:: If an I/O error has occurred.

flush	back to summary
public void flush() throws IOException Implements java.io.ObjectOutput.flush. Doc from java.io.ObjectOutput.flush. Flushes the stream. This will write any buffered output bytes. Exceptions IOException: If an I/O error has occurred.

flush

back to summary

public void flush() throws IOException

Implements java.io.ObjectOutput.flush.

Doc from java.io.ObjectOutput.flush.

Flushes the stream. This will write any buffered output bytes.

Exceptions

IOException:: If an I/O error has occurred.

write	back to summary
public void write(final int b) throws IOException Implements java.io.ObjectOutput.write. Doc from java.io.ObjectOutput.write. Writes a byte. This method will block until the byte is actually written. Parameters b:int the byte Exceptions IOException: If an I/O error has occurred.

write

back to summary

public void write(final int b) throws IOException

Implements java.io.ObjectOutput.write.

Doc from java.io.ObjectOutput.write.

Writes a byte. This method will block until the byte is actually written.

Parameters

b:int: the byte

Exceptions

IOException:: If an I/O error has occurred.

write	back to summary
public void write(final byte[] b) throws IOException Implements java.io.ObjectOutput.write. Doc from java.io.ObjectOutput.write. Writes an array of bytes. This method will block until the bytes are actually written. Parameters b:byte[] the data to be written Exceptions IOException: If an I/O error has occurred.

write

back to summary

public void write(final byte[] b) throws IOException

Implements java.io.ObjectOutput.write.

Doc from java.io.ObjectOutput.write.

Writes an array of bytes. This method will block until the bytes are actually written.

Parameters

b:byte[]: the data to be written

Exceptions

IOException:: If an I/O error has occurred.

write	back to summary
public void write(final byte[] b, final int off, final int len) throws IOException Implements java.io.ObjectOutput.write. Doc from java.io.ObjectOutput.write. Writes a sub array of bytes. Parameters b:byte[] the data to be written off:int the start offset in the data len:int the number of bytes that are written Exceptions IOException: If an I/O error has occurred.

write

back to summary

public void write(final byte[] b, final int off, final int len) throws IOException

Implements java.io.ObjectOutput.write.

Doc from java.io.ObjectOutput.write.

Writes a sub array of bytes.

Parameters

b:byte[]: the data to be written
off:int: the start offset in the data
len:int: the number of bytes that are written

Exceptions

IOException:: If an I/O error has occurred.

writeBoolean back to summary

writeBoolean	back 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.

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.

writeByte back to summary

writeByte	back 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.

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.

writeBytes back to summary

writeBytes	back 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.

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.

writeChar back to summary

writeChar	back 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.

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.

writeChars back to summary

writeChars	back 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.

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.

writeDouble back to summary

writeDouble	back 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.

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.

writeFloat back to summary

writeFloat	back 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.

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.

writeInt back to summary

writeInt	back 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.

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.

writeLong back to summary

writeLong	back 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.

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.

writeObject	back to summary
public void writeObject(final Object obj) throws IOException Implements java.io.ObjectOutput.writeObject. Doc from java.io.ObjectOutput.writeObject. Write an object to the underlying storage or stream. The class that implements this interface defines how the object is written. Parameters obj:Object the object to be written Exceptions IOException: Any of the usual Input/Output related exceptions.

writeObject

back to summary

public void writeObject(final Object obj) throws IOException

Implements java.io.ObjectOutput.writeObject.

Doc from java.io.ObjectOutput.writeObject.

Write an object to the underlying storage or stream. The class that implements this interface defines how the object is written.

Parameters

obj:Object: the object to be written

Exceptions

IOException:: Any of the usual Input/Output related exceptions.

writeShort back to summary

writeShort	back 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.

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.

writeUTF back to summary

writeUTF	back 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.

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.

public Class MarshallerObjectOutput

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail