Module com.aoapps.lang

Package com.aoapps.lang.io

Class FastObjectInput

java.lang.Object

com.aoapps.lang.io.FastObjectInput

All Implemented Interfaces:

DataInput, ObjectInput, AutoCloseable

public class FastObjectInput
extends Object
implements ObjectInput

Utilities to read FastExternalizable, Externalizable, and Serializable objects.

When multiple objects are being written, this avoids the repetitive writing of classnames and serialVersionUIDs.

Any object that is ObjectInputValidation is validated immediately - there is no need and no mechanism to register the validation since this is for simple value objects that don't participate in more complex object graphs.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
protected FastExternalizable	readFastObject()	Reads a FastExternalizable object from the stream.
String	readFastUTF()	Reads a fast serialized String from the stream.
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
int	readInt()
String	readLine()
long	readLong()
Object	readObject()	Reads a possibly-FastExternalizable object from the stream.
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
String	readUTF()
long	skip(long n)
int	skipBytes(int n)
void	unwrap()	Unwraps the object input.
static FastObjectInput	wrap(ObjectInput in)	Gets the wrapper for the provided ObjectInput, creating if needed.

Methods inherited from class java.lang.Object

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

Method Detail

wrap

public static FastObjectInput wrap(ObjectInput in)
                            throws IOException

Gets the wrapper for the provided ObjectInput, creating if needed. To avoid memory leaks, it must also be unwrapped in a finally block.

TODO: Can FastObjectInput itself implement AutoCloseable for unwrap()? Maybe this means it no longer implements ObjectInput directly?

Throws:

IOException

unwrap

public void unwrap()
            throws IllegalStateException

Unwraps the object input.

Throws:

IllegalStateException - if not wrapped

readObject

public Object readObject()
                  throws IOException,
                         ClassNotFoundException

Reads a possibly-FastExternalizable object from the stream.

Specified by:

readObject in interface ObjectInput

Throws:

IOException

ClassNotFoundException

See Also:

FastObjectOutput.writeObject(java.lang.Object)

readFastObject

protected FastExternalizable readFastObject()
                                     throws IOException,
                                            ClassNotFoundException

Reads a FastExternalizable object from the stream.

Throws:

IOException

ClassNotFoundException

See Also:

FastObjectOutput.writeFastObject(com.aoapps.lang.io.FastExternalizable)

readFastUTF

public String readFastUTF()
                   throws IOException

Reads a fast serialized String from the stream.

Throws:

IOException

See Also:

FastObjectOutput.writeFastUTF(java.lang.String)

read

public int read()
         throws IOException

Specified by:

read in interface ObjectInput

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Specified by:

read in interface ObjectInput

Throws:

IOException

read

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

Specified by:

read in interface ObjectInput

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Specified by:

skip in interface ObjectInput

Throws:

IOException

available

public int available()
              throws IOException

Specified by:

available in interface ObjectInput

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ObjectInput

Throws:

IOException

readFully

public void readFully(byte[] b)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

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

Specified by:

readFully in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int n)
              throws IOException

Specified by:

skipBytes in interface DataInput

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

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

readChar

public char readChar()
              throws IOException

Specified by:

readChar 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

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException