Package org.jboss.marshalling

Class ObjectInputStreamUnmarshaller

java.lang.Object

org.jboss.marshalling.ObjectInputStreamUnmarshaller

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, AutoCloseable, ByteInput, Unmarshaller

public class ObjectInputStreamUnmarshaller
extends Object
implements Unmarshaller

An Unmarshaller which simply wraps an object stream. Useful for retrofitting and testing applications.

Constructor Summary

Constructors

Constructor	Description
ObjectInputStreamUnmarshaller(ObjectInputStream ois)	Construct a new instance which wraps the given stream.

Method Summary

Modifier and Type	Method	Description
int	available()	Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
void	clearClassCache()	Discard the class cache.
void	clearInstanceCache()	Discard the instance cache.
void	close()
void	finish()	Finish unmarshalling from a stream.
int	read()	Reads the next byte of data from the input stream.
int	read(byte[] b)	Read some bytes from the input stream into the given array.
int	read(byte[] buf, int off, int len)	Read some bytes from the input stream into the given array.
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
float	readFloat()
void	readFully(byte[] buf)
void	readFully(byte[] buf, int off, int len)
int	readInt()
String	readLine()	Deprecated.
long	readLong()
Object	readObject()
<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.
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
String	readUTF()
long	skip(long n)	Skips over and discards up to n bytes of data from this input stream.
int	skipBytes(int len)
void	start(ByteInput newInput)	Begin unmarshalling from a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectInputStreamUnmarshaller

public ObjectInputStreamUnmarshaller(ObjectInputStream ois)

Construct a new instance which wraps the given stream.

Parameters:

ois - the object stream to wrap

Method Detail

readObject

public Object readObject()
                  throws IOException,
                         ClassNotFoundException

Specified by:

readObject in interface ObjectInput

Throws:

IOException

ClassNotFoundException

readObjectUnshared

public Object readObjectUnshared()
                          throws IOException,
                                 ClassNotFoundException

Read and return an unshared object.

Specified by:

readObjectUnshared in interface Unmarshaller

Returns:

an unshared object

Throws:

IOException - if an error occurs

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

read

public int read()
         throws IOException

Reads the next byte of data from the input stream. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in interface ByteInput

Specified by:

read in interface ObjectInput

Returns:

the next byte, or -1 if the end of stream has been reached

Throws:

IOException - if an error occurs

read

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

Read some bytes from the input stream into the given array. Returns the number of bytes actually read (possibly zero), or -1 if the end of stream has been reached.

Specified by:

read in interface ByteInput

Specified by:

read in interface ObjectInput

Parameters:

buf - the destination array

off - the offset into the array into which data should be read

len - the number of bytes to attempt to fill in the destination array

Returns:

the number of bytes read (possibly zero), or -1 if the end of stream has been reached

Throws:

IOException - if an error occurs

available

public int available()
              throws IOException

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.

Specified by:

available in interface ByteInput

Specified by:

available in interface ObjectInput

Returns:

the number of bytes

Throws:

IOException - if an error occurs

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ObjectInput

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] buf)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

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

Specified by:

readFully in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int len)
              throws IOException

Specified by:

skipBytes in interface DataInput

Throws:

IOException

readLine

@Deprecated
public String readLine()
                throws IOException

Deprecated.

Specified by:

readLine in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Read some bytes from the input stream into the given array. Returns the number of bytes actually read (possibly zero), or -1 if the end of stream has been reached.

Specified by:

read in interface ByteInput

Specified by:

read in interface ObjectInput

Parameters:

b - the destination array

Returns:

the number of bytes read (possibly zero), or -1 if the end of stream has been reached

Throws:

IOException - if an error occurs

skip

public long skip(long n)
          throws IOException

Skips over and discards up to n bytes of data from this input stream. If the end of stream is reached, this method returns 0 in order to be consistent with InputStream.skip(long).

Specified by:

skip in interface ByteInput

Specified by:

skip in interface ObjectInput

Parameters:

n - the number of bytes to attempt to skip

Returns:

the number of bytes skipped

Throws:

IOException - if an error occurs

start

public void start(ByteInput newInput)
           throws IOException

Begin unmarshalling from a stream.

Specified by:

start in interface Unmarshaller

Parameters:

newInput - the new stream

Throws:

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

clearInstanceCache

public void clearInstanceCache()
                        throws IOException

Discard the instance cache.

Specified by:

clearInstanceCache in interface Unmarshaller

Throws:

IOException - if an error occurs

clearClassCache

public void clearClassCache()
                     throws IOException

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

Specified by:

clearClassCache in interface Unmarshaller

Throws:

IOException - if an error occurs

finish

public void finish()
            throws IOException

Finish unmarshalling from a stream. Any transient class or instance cache is discarded.

Specified by:

finish in interface Unmarshaller

Throws:

IOException - if an error occurs

readObject

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

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

Specified by:

readObject in interface Unmarshaller

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

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

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

Specified by:

readObjectUnshared in interface Unmarshaller

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