Top Description Methods
org.jboss.marshalling

public Interface Marshaller

extends ObjectOutput, ByteOutput
Known Direct Implementers
org.jboss.marshalling.ObjectOutputStreamMarshaller, org.jboss.marshalling.cloner.SerializingCloner.StepObjectOutput, org.jboss.marshalling.AbstractMarshaller
Imports
java.io.ObjectOutput, .IOException

An object marshaller for writing objects to byte streams.

Method Summary

Modifier and TypeMethod and Description
public void
clearClassCache()

Discard the class cache.

public void
clearInstanceCache()

Discard the instance cache.

public void
finish()

Finish marshalling to a stream.

public void
start(ByteOutput
the new stream
newOutput
)

Begin marshalling to a stream.

public void
writeObjectUnshared(Object
the object to be written
obj
)

Write an object to the underlying storage or stream as a new instance.

Inherited from java.io.ObjectOutput:
closeflushwritewritewritewriteObject
Inherited from org.jboss.marshalling.ByteOutput:
writewritewrite

Method Detail

clearClassCacheback to summary
public void clearClassCache() throws IOException

Discard the class cache. Implicitly also discards the instance cache.

Exceptions
IOException:
if an error occurs
clearInstanceCacheback to summary
public void clearInstanceCache() throws IOException

Discard the instance cache. May also discard the class cache in implementations that do not support separated class and instance caches.

Exceptions
IOException:
if an error occurs
finishback to summary
public void finish() throws IOException

Finish marshalling to a stream. Any transient class or instance cache is discarded. The stream is released. No further marshalling may be done until the start(ByteOutput) method is again invoked.

Exceptions
IOException:
if an error occurs
startback to summary
public void start(ByteOutput newOutput) throws IOException

Begin marshalling to a stream.

Parameters
newOutput:ByteOutput

the new stream

Exceptions
IOException:
if an error occurs during setup, such as an error writing the header
writeObjectUnsharedback to summary
public void writeObjectUnshared(Object obj) throws IOException

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

Parameters
obj:Object

the object to be written

Exceptions
IOException:
if an error occurs