Package org.jboss.marshalling

Interface Unmarshaller

All Superinterfaces:

AutoCloseable, ByteInput, Closeable, DataInput, ObjectInput

All Known Implementing Classes:

AbstractUnmarshaller, ObjectInputStreamUnmarshaller

public interface Unmarshaller
extends ObjectInput, ByteInput

An unmarshaller which reads objects from a stream.

Method Summary

Modifier and Type	Method	Description
void	clearClassCache()	Discard the class cache.
void	clearInstanceCache()	Discard the instance cache.
void	finish()	Finish unmarshalling from a stream.
<T> T	readObject(Class<T> type)	Read and return an object, cast to a specific type.
Object	readObjectUnshared()	Read and return an unshared object.
<T> T	readObjectUnshared(Class<T> type)	Read and return an unshared object, cast to a specific type.
void	start(ByteInput newInput)	Begin unmarshalling from a stream.

Methods inherited from interface org.jboss.marshalling.ByteInput

available, read, read, read, skip

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes

Methods inherited from interface java.io.ObjectInput

available, close, read, read, read, readObject, skip

Method Detail

readObjectUnshared

Object readObjectUnshared()
                   throws ClassNotFoundException,
                          IOException

Read and return an unshared object.

Returns:

an unshared object

Throws:

ClassNotFoundException - if the class of a serialized object cannot be found

IOException - if an error occurs

readObject

<T> T readObject(Class<T> type)
          throws ClassNotFoundException,
                 IOException

Read and return an object, cast to a specific type.

Type Parameters:

T - the object type

Parameters:

type - the object class

Returns:

the object read from the stream

Throws:

ClassNotFoundException - if the class of a serialized object cannot be found

InvalidObjectException - if the object is not of the expected type

IOException - if an error occurs

readObjectUnshared

<T> T readObjectUnshared(Class<T> type)
                  throws ClassNotFoundException,
                         IOException

Read and return an unshared object, cast to a specific type.

Type Parameters:

T - the object type

Parameters:

type - the object class

Returns:

an unshared object

Throws:

ClassNotFoundException - if the class of a serialized object cannot be found

InvalidObjectException - if the object is not of the expected type

IOException - if an error occurs

start

void start(ByteInput newInput)
    throws IOException

Begin unmarshalling from a stream.

Parameters:

newInput - the new stream

Throws:

IOException - if an error occurs during setup, such as an invalid header

clearInstanceCache

void clearInstanceCache()
                 throws IOException

Discard the instance cache.

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 unmarshalling from a stream. Any transient class or instance cache is discarded.

Throws:

IOException - if an error occurs