Class CustomObjectOutputStream

java.lang.Object

java.io.OutputStream

java.io.ObjectOutputStream

com.thoughtworks.xstream.core.util.CustomObjectOutputStream

All Implemented Interfaces:

Closeable, DataOutput, Flushable, ObjectOutput, ObjectStreamConstants, AutoCloseable

public class CustomObjectOutputStream
extends ObjectOutputStream

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	CustomObjectOutputStream.CustomPutField
static interface	CustomObjectOutputStream.StreamCallback

Nested classes/interfaces inherited from class ObjectOutputStream

ObjectOutputStream.PutField

Field Summary

Fields

Modifier and Type	Field	Description
private FastStack	callbacks
private FastStack	customFields
private static final String	DATA_HOLDER_KEY

Fields inherited from interface ObjectStreamConstants

baseWireHandle, PROTOCOL_VERSION_1, PROTOCOL_VERSION_2, SC_BLOCK_DATA, SC_ENUM, SC_EXTERNALIZABLE, SC_SERIALIZABLE, SC_WRITE_METHOD, SERIAL_FILTER_PERMISSION, STREAM_MAGIC, STREAM_VERSION, SUBCLASS_IMPLEMENTATION_PERMISSION, SUBSTITUTION_PERMISSION, TC_ARRAY, TC_BASE, TC_BLOCKDATA, TC_BLOCKDATALONG, TC_CLASS, TC_CLASSDESC, TC_ENDBLOCKDATA, TC_ENUM, TC_EXCEPTION, TC_LONGSTRING, TC_MAX, TC_NULL, TC_OBJECT, TC_PROXYCLASSDESC, TC_REFERENCE, TC_RESET, TC_STRING

Constructor Summary

Constructors

Constructor	Description
CustomObjectOutputStream(CustomObjectOutputStream.StreamCallback callback)	Warning, this object is expensive to create (due to functionality inherited from superclass).

Method Summary

Modifier and Type	Method	Description
void	close()
void	defaultWriteObject()	Methods to delegate to callback
void	flush()
static CustomObjectOutputStream	getInstance(DataHolder whereFrom, CustomObjectOutputStream.StreamCallback callback)
CustomObjectOutputStream.StreamCallback	peekCallback()
CustomObjectOutputStream.StreamCallback	popCallback()
void	pushCallback(CustomObjectOutputStream.StreamCallback callback)	Allows the CustomObjectOutputStream (which is expensive to create) to be reused.
ObjectOutputStream.PutField	putFields()
void	reset()	Unsupported methods
void	useProtocolVersion(int version)
void	write(byte[] buf)
void	write(byte[] buf, int off, int len)
void	write(int val)
void	writeBoolean(boolean val)
void	writeByte(int val)
void	writeBytes(String str)
void	writeChar(int val)
void	writeChars(String str)
void	writeDouble(double val)
void	writeFields()
void	writeFloat(float val)
void	writeInt(int val)
void	writeLong(long val)
protected void	writeObjectOverride(Object obj)
void	writeShort(int val)
void	writeUnshared(Object obj)
void	writeUTF(String str)

Methods inherited from class ObjectOutputStream

annotateClass, annotateProxyClass, drain, enableReplaceObject, replaceObject, writeClassDescriptor, writeObject, writeStreamHeader

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Field Details

callbacks

private FastStack callbacks

customFields

private FastStack customFields

DATA_HOLDER_KEY

private static final String DATA_HOLDER_KEY

Constructor Details

CustomObjectOutputStream

public CustomObjectOutputStream(CustomObjectOutputStream.StreamCallback callback)
                         throws IOException,
SecurityException

Warning, this object is expensive to create (due to functionality inherited from superclass). Use the static fetch() method instead, wherever possible.

Throws:

IOException

SecurityException

See Also:

• getInstance(com.thoughtworks.xstream.converters.DataHolder, com.thoughtworks.xstream.core.util.CustomObjectOutputStream.StreamCallback)

Method Details

getInstance

public static CustomObjectOutputStream getInstance(DataHolder whereFrom,
 CustomObjectOutputStream.StreamCallback callback)

pushCallback

public void pushCallback(CustomObjectOutputStream.StreamCallback callback)

Allows the CustomObjectOutputStream (which is expensive to create) to be reused.

popCallback

public CustomObjectOutputStream.StreamCallback popCallback()

peekCallback

public CustomObjectOutputStream.StreamCallback peekCallback()

defaultWriteObject

public void defaultWriteObject()
                        throws IOException

Methods to delegate to callback

Overrides:

defaultWriteObject in class ObjectOutputStream

Throws:

IOException

writeObjectOverride

protected void writeObjectOverride(Object obj)
                            throws IOException

Overrides:

writeObjectOverride in class ObjectOutputStream

Throws:

IOException

writeBoolean

public void writeBoolean(boolean val)
                  throws IOException

Specified by:

writeBoolean in interface DataOutput

Overrides:

writeBoolean in class ObjectOutputStream

Throws:

IOException

writeByte

public void writeByte(int val)
               throws IOException

Specified by:

writeByte in interface DataOutput

Overrides:

writeByte in class ObjectOutputStream

Throws:

IOException

writeInt

public void writeInt(int val)
              throws IOException

Specified by:

writeInt in interface DataOutput

Overrides:

writeInt in class ObjectOutputStream

Throws:

IOException

writeChar

public void writeChar(int val)
               throws IOException

Specified by:

writeChar in interface DataOutput

Overrides:

writeChar in class ObjectOutputStream

Throws:

IOException

writeDouble

public void writeDouble(double val)
                 throws IOException

Specified by:

writeDouble in interface DataOutput

Overrides:

writeDouble in class ObjectOutputStream

Throws:

IOException

writeFloat

public void writeFloat(float val)
                throws IOException

Specified by:

writeFloat in interface DataOutput

Overrides:

writeFloat in class ObjectOutputStream

Throws:

IOException

writeLong

public void writeLong(long val)
               throws IOException

Specified by:

writeLong in interface DataOutput

Overrides:

writeLong in class ObjectOutputStream

Throws:

IOException

writeShort

public void writeShort(int val)
                throws IOException

Specified by:

writeShort in interface DataOutput

Overrides:

writeShort in class ObjectOutputStream

Throws:

IOException

write

public void write(byte[] buf)
           throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class ObjectOutputStream

Throws:

IOException

writeChars

public void writeChars(String str)
                throws IOException

Specified by:

writeChars in interface DataOutput

Overrides:

writeChars in class ObjectOutputStream

Throws:

IOException

writeUTF

public void writeUTF(String str)
              throws IOException

Specified by:

writeUTF in interface DataOutput

Overrides:

writeUTF in class ObjectOutputStream

Throws:

IOException

write

public void write(int val)
           throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class ObjectOutputStream

Throws:

IOException

write

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

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class ObjectOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface ObjectOutput

Overrides:

flush in class ObjectOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ObjectOutput

Overrides:

close in class ObjectOutputStream

Throws:

IOException

putFields

public ObjectOutputStream.PutField putFields()

Overrides:

putFields in class ObjectOutputStream

writeFields

public void writeFields()
                 throws IOException

Overrides:

writeFields in class ObjectOutputStream

Throws:

IOException

reset

public void reset()

Unsupported methods

Overrides:

reset in class ObjectOutputStream

useProtocolVersion

public void useProtocolVersion(int version)

Overrides:

useProtocolVersion in class ObjectOutputStream

writeBytes

public void writeBytes(String str)

Specified by:

writeBytes in interface DataOutput

Overrides:

writeBytes in class ObjectOutputStream

writeUnshared

public void writeUnshared(Object obj)

Overrides:

writeUnshared in class ObjectOutputStream