JBoss Marshalling 1.3.0.GA

org.jboss.marshalling
Interface Unmarshaller

All Superinterfaces:
ByteInput, java.io.Closeable, java.io.DataInput, java.io.ObjectInput
All Known Implementing Classes:
AbstractUnmarshaller, BlockUnmarshaller, BlockUnmarshaller, ObjectInputStreamUnmarshaller, RiverUnmarshaller, SerialUnmarshaller

public interface Unmarshaller
extends java.io.ObjectInput, ByteInput

An unmarshaller which reads objects from a stream.


Method Summary
 void clearClassCache()
          Discard the class cache.
 void clearInstanceCache()
          Discard the instance cache.
 void finish()
          Finish unmarshalling from a stream.
<T> T
readObject(java.lang.Class<T> type)
          Read and return an object, cast to a specific type.
 java.lang.Object readObjectUnshared()
          Read and return an unshared object.
<T> T
readObjectUnshared(java.lang.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 java.io.ObjectInput
available, close, read, read, read, readObject, skip
 
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 org.jboss.marshalling.ByteInput
available, read, read, read, skip
 
Methods inherited from interface java.io.Closeable
close
 

Method Detail

readObjectUnshared

java.lang.Object readObjectUnshared()
                                    throws java.lang.ClassNotFoundException,
                                           java.io.IOException
Read and return an unshared object.

Returns:
an unshared object
Throws:
java.lang.ClassNotFoundException - if the class of a serialized object cannot be found
java.io.IOException - if an error occurs

readObject

<T> T readObject(java.lang.Class<T> type)
             throws java.lang.ClassNotFoundException,
                    java.io.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:
java.lang.ClassNotFoundException - if the class of a serialized object cannot be found
java.io.InvalidObjectException - if the object is not of the expected type
java.io.IOException - if an error occurs

readObjectUnshared

<T> T readObjectUnshared(java.lang.Class<T> type)
                     throws java.lang.ClassNotFoundException,
                            java.io.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:
java.lang.ClassNotFoundException - if the class of a serialized object cannot be found
java.io.InvalidObjectException - if the object is not of the expected type
java.io.IOException - if an error occurs

start

void start(ByteInput newInput)
           throws java.io.IOException
Begin unmarshalling from a stream.

Parameters:
newInput - the new stream
Throws:
java.io.IOException - if an error occurs during setup, such as an invalid header

clearInstanceCache

void clearInstanceCache()
                        throws java.io.IOException
Discard the instance cache.

Throws:
java.io.IOException - if an error occurs

clearClassCache

void clearClassCache()
                     throws java.io.IOException
Discard the class cache. Implicitly also discards the instance cache.

Throws:
java.io.IOException - if an error occurs

finish

void finish()
            throws java.io.IOException
Finish unmarshalling from a stream. Any transient class or instance cache is discarded.

Throws:
java.io.IOException - if an error occurs

JBoss Marshalling 1.3.0.GA

Copyright © 2011 JBoss, a division of Red Hat, Inc.