Package org.jboss.marshalling
Interface Marshaller
-
- All Superinterfaces:
AutoCloseable
,ByteOutput
,Closeable
,DataOutput
,Flushable
,ObjectOutput
- All Known Implementing Classes:
AbstractMarshaller
,ObjectOutputStreamMarshaller
public interface Marshaller extends ObjectOutput, ByteOutput
An object marshaller for writing objects to byte streams.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearClassCache()
Discard the class cache.void
clearInstanceCache()
Discard the instance cache.void
finish()
Finish marshalling to a stream.void
start(ByteOutput newOutput)
Begin marshalling to a stream.void
writeObjectUnshared(Object obj)
Write an object to the underlying storage or stream as a new instance.-
Methods inherited from interface org.jboss.marshalling.ByteOutput
write, write, write
-
Methods inherited from interface java.io.DataOutput
writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF
-
Methods inherited from interface java.io.ObjectOutput
close, flush, write, write, write, writeObject
-
-
-
-
Method Detail
-
writeObjectUnshared
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
- the object to be written- Throws:
IOException
- if an error occurs
-
start
void start(ByteOutput newOutput) throws IOException
Begin marshalling to a stream.- Parameters:
newOutput
- the new stream- Throws:
IOException
- if an error occurs during setup, such as an error writing the header
-
clearInstanceCache
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.- Throws:
IOException
- if an error occurs
-
clearClassCache
void clearClassCache() throws IOException
Discard the class cache. Implicitly also discards the instance cache.- Throws:
IOException
- if an error occurs
-
finish
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 thestart(ByteOutput)
method is again invoked.- Throws:
IOException
- if an error occurs
-
-