|
Marshalling API version 1.0.0.GA | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.marshalling.AbstractMarshaller
public abstract class AbstractMarshaller
An abstract implementation of the Marshaller
interface. Most of the
write methods delegate directly to the current data output.
Field Summary | |
---|---|
protected ByteOutput |
byteOutput
The current byte output. |
protected ClassResolver |
classResolver
The configured class resolver. |
protected ClassTable |
classTable
The configured class table. |
protected Creator |
creator
The configured object creator. |
protected ExternalizerFactory |
externalizerFactory
The configured externalizer factory. |
protected ObjectResolver |
objectResolver
The configured object resolver. |
protected ObjectTable |
objectTable
The configured object table. |
protected StreamHeader |
streamHeader
The configured stream header. |
Constructor Summary | |
---|---|
protected |
AbstractMarshaller(AbstractMarshallerFactory marshallerFactory,
MarshallingConfiguration configuration)
Construct a new marshaller instance. |
Method Summary | |
---|---|
void |
close()
Closes the stream. |
protected void |
doStart()
Perform any marshaller-specific start activity. |
protected abstract void |
doWriteObject(Object obj,
boolean unshared)
Implementation of the actual object-writing method. |
void |
finish()
Finish marshalling to a stream. |
void |
flush()
Flushes the stream. |
void |
start(ByteOutput byteOutput)
Begin marshalling to a stream. |
void |
write(byte[] bytes)
Writes an array of bytes. |
void |
write(byte[] bytes,
int off,
int len)
Writes a sub array of bytes. |
void |
write(int v)
Writes a byte. |
void |
writeBoolean(boolean v)
Writes a boolean value to this output stream. |
void |
writeByte(int v)
Writes to the output stream the eight low- order bits of the argument v . |
void |
writeBytes(String s)
Writes a string to the output stream. |
void |
writeChar(int v)
Writes a char value, which
is comprised of two bytes, to the
output stream. |
void |
writeChars(String s)
Writes every character in the string s ,
to the output stream, in order,
two bytes per character. |
void |
writeDouble(double v)
Writes a double value,
which is comprised of eight bytes, to the output stream. |
void |
writeFloat(float v)
Writes a float value,
which is comprised of four bytes, to the output stream. |
void |
writeInt(int v)
Writes an int value, which is
comprised of four bytes, to the output stream. |
void |
writeLong(long v)
Writes a long value, which is
comprised of eight bytes, to the output stream. |
void |
writeObject(Object obj)
Write an object to the underlying storage or stream. |
void |
writeObjectUnshared(Object obj)
Write an object to the underlying storage or stream as a new instance. |
void |
writeShort(int v)
Writes two bytes to the output stream to represent the value of the argument. |
void |
writeUTF(String s)
Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jboss.marshalling.Marshaller |
---|
clearClassCache, clearInstanceCache |
Field Detail |
---|
protected final ExternalizerFactory externalizerFactory
protected final StreamHeader streamHeader
protected final ClassResolver classResolver
protected final ObjectResolver objectResolver
protected final Creator creator
protected final ClassTable classTable
protected final ObjectTable objectTable
protected ByteOutput byteOutput
Constructor Detail |
---|
protected AbstractMarshaller(AbstractMarshallerFactory marshallerFactory, MarshallingConfiguration configuration)
marshallerFactory
- the marshaller factoryconfiguration
- Method Detail |
---|
public void write(int v) throws IOException
write
in interface DataOutput
write
in interface ObjectOutput
write
in interface ByteOutput
v
- the byte
IOException
- If an I/O error has occurred.public void write(byte[] bytes) throws IOException
write
in interface DataOutput
write
in interface ObjectOutput
write
in interface ByteOutput
bytes
- the data to be written
IOException
- If an I/O error has occurred.public void write(byte[] bytes, int off, int len) throws IOException
write
in interface DataOutput
write
in interface ObjectOutput
write
in interface ByteOutput
bytes
- the data to be writtenoff
- the start offset in the datalen
- the number of bytes that are written
IOException
- If an I/O error has occurred.public void writeBoolean(boolean v) throws IOException
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
.
writeBoolean
in interface DataOutput
v
- the boolean to be written.
IOException
- if an I/O error occurs.public void writeByte(int v) throws IOException
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
.
writeByte
in interface DataOutput
v
- the byte value to be written.
IOException
- if an I/O error occurs.public void writeShort(int v) throws IOException
(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
.
writeShort
in interface DataOutput
v
- the short
value to be written.
IOException
- if an I/O error occurs.public void writeChar(int v) throws IOException
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
.
writeChar
in interface DataOutput
v
- the char
value to be written.
IOException
- if an I/O error occurs.public void writeInt(int v) throws IOException
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
.
writeInt
in interface DataOutput
v
- the int
value to be written.
IOException
- if an I/O error occurs.public void writeLong(long v) throws IOException
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
.
writeLong
in interface DataOutput
v
- the long
value to be written.
IOException
- if an I/O error occurs.public void writeFloat(float v) throws IOException
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
.
writeFloat
in interface DataOutput
v
- the float
value to be written.
IOException
- if an I/O error occurs.public void writeDouble(double v) throws IOException
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
.
writeDouble
in interface DataOutput
v
- the double
value to be written.
IOException
- if an I/O error occurs.public void writeBytes(String s) throws IOException
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.
writeBytes
in interface DataOutput
s
- the string of bytes to be written.
IOException
- if an I/O error occurs.public void writeChars(String s) throws IOException
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.
writeChars
in interface DataOutput
s
- the string value to be written.
IOException
- if an I/O error occurs.public void writeUTF(String s) throws IOException
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
.
writeUTF
in interface DataOutput
s
- the string value to be written.
IOException
- if an I/O error occurs.public void flush() throws IOException
flush
in interface Flushable
flush
in interface ObjectOutput
IOException
- If an I/O error has occurred.public void close() throws IOException
close
in interface Closeable
close
in interface ObjectOutput
IOException
- If an I/O error has occurred.public void start(ByteOutput byteOutput) throws IOException
start
in interface Marshaller
byteOutput
- the new stream
IOException
- if an error occurs during setup, such as an error writing the headerpublic void finish() throws IOException
Marshaller.start(ByteOutput)
method is again invoked.
finish
in interface Marshaller
IOException
- if an error occursprotected abstract void doWriteObject(Object obj, boolean unshared) throws IOException
obj
- the object to writeunshared
- true
if the instance is unshared, false
if it is shared
IOException
- if an I/O error occurspublic final void writeObjectUnshared(Object obj) throws IOException
writeObjectUnshared
in interface Marshaller
obj
- the object to be written
IOException
- if an error occurspublic final void writeObject(Object obj) throws IOException
writeObject
in interface ObjectOutput
obj
- the object to be written
IOException
- Any of the usual Input/Output related exceptions.protected void doStart() throws IOException
IOException
- if I/O exception occurs
|
Marshalling API version 1.0.0.GA | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |