org.nustaq.serialization

Class FSTObjectInput

java.lang.Object

org.nustaq.serialization.FSTObjectInput

All Implemented Interfaces:

DataInput, ObjectInput, AutoCloseable

Direct Known Subclasses:

FSTObjectInputNoShared

public class FSTObjectInput
extends Object
implements ObjectInput

replacement of ObjectInputStream

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FSTObjectInput.CallbackEntry
static interface	FSTObjectInput.ConditionalCallback
protected static class	FSTObjectInput.MyObjectStream

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<FSTObjectInput.CallbackEntry>	callbacks
protected FSTClazzInfoRegistry	clInfoRegistry
protected boolean	closed
protected FSTDecoder	codec
protected FSTObjectInput.ConditionalCallback	conditionalCallback
protected FSTConfiguration	conf
protected int	curDepth
protected Stack<String>	debugStack
static ByteArrayInputStream	emptyStream
protected FSTObjectInput.MyObjectStream	fakeWrapper
protected boolean	ignoreAnnotations
protected FSTClazzInfo.FSTFieldInfo	infoCache
protected boolean	isCrossPlatform
protected FSTObjectRegistry	objects
protected int	readExternalReadAHead
static boolean	REGISTER_ENUMS_READ
protected VersionConflictListener	versionConflictListener

Constructor Summary

Constructors

Constructor and Description
FSTObjectInput()
FSTObjectInput(FSTConfiguration conf)
FSTObjectInput(InputStream in) Creates a FSTObjectInput that uses the specified underlying InputStream.
FSTObjectInput(InputStream in, FSTConfiguration conf) Creates a FSTObjectInput that uses the specified underlying InputStream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	defaultReadObject(FSTClazzInfo.FSTFieldInfo referencee, FSTClazzInfo serializationInfo, Object newObj)
Class	getClassForName(String name)
protected FSTClazzInfo	getClazzInfo(Class c, FSTClazzInfo.FSTFieldInfo referencee)
FSTDecoder	getCodec()
FSTObjectInput.ConditionalCallback	getConditionalCallback()
FSTConfiguration	getConf()
protected ObjectInputStream	getObjectInputStream(Class cl, FSTClazzInfo clInfo, FSTClazzInfo.FSTFieldInfo referencee, Object toRead)
int	getReadExternalReadAHead()
VersionConflictListener	getVersionConflictListener()
protected Object	handleReadRessolve(FSTClazzInfo serializationInfo, Object newObj)
protected void	initRegistries(FSTConfiguration conf)
protected Object	instantiateAndReadNoSer(Class c, FSTClazzInfo clzSerInfo, FSTClazzInfo.FSTFieldInfo referencee, int readPos)
protected Object	instantiateAndReadWithSer(Class c, FSTObjectSerializer ser, FSTClazzInfo clzSerInfo, FSTClazzInfo.FSTFieldInfo referencee, int readPos)
protected Object	instantiateArray(FSTClazzInfo.FSTFieldInfo referencee, int readPos)
protected Object	instantiateBigInt()
protected Object	instantiateEnum(FSTClazzInfo.FSTFieldInfo referencee, int readPos)
protected Object	instantiateHandle(FSTClazzInfo.FSTFieldInfo referencee)
protected Object	instantiateSpecialTag(FSTClazzInfo.FSTFieldInfo referencee, int readPos, byte code)
protected void	oldVersionRead(Object newObj)
protected void	processValidation()
protected void	pushBack(int i)
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
protected Object	readArray(FSTClazzInfo.FSTFieldInfo referencee)
protected Object	readArrayNoHeader(FSTClazzInfo.FSTFieldInfo referencee, int pos, Class arrCl)
boolean	readBoolean()
byte	readByte()
char	readChar()
FSTClazzInfo	readClass()
protected void	readCompatibleObjectFields(FSTClazzInfo.FSTFieldInfo referencee, FSTClazzInfo serializationInfo, FSTClazzInfo.FSTFieldInfo[] fieldInfo, Map res)
double	readDouble()
protected void	readFieldsMapBased(FSTClazzInfo.FSTFieldInfo referencee, FSTClazzInfo serializationInfo, Object newObj)
int	readFInt()
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
int	readInt()
String	readLine()
long	readLong()
Object	readObject()
Object	readObject(Class... possibles)
protected Object	readObjectCompatible(FSTClazzInfo.FSTFieldInfo referencee, FSTClazzInfo serializationInfo, Object newObj)
protected void	readObjectCompatibleRecursive(FSTClazzInfo.FSTFieldInfo referencee, Object toRead, FSTClazzInfo serializationInfo, Class cl)
protected void	readObjectFields(FSTClazzInfo.FSTFieldInfo referencee, FSTClazzInfo serializationInfo, FSTClazzInfo.FSTFieldInfo[] fieldInfo, Object newObj, int startIndex, int version)
Object	readObjectInternal(Class... expected)
Object	readObjectWithHeader(FSTClazzInfo.FSTFieldInfo referencee)
short	readShort()
String	readStringAsc() len < 127 !!!!!
String	readStringUTF()
int	readUnsignedByte()
int	readUnsignedShort()
String	readUTF()
void	registerObject(Object o, int streamPosition, FSTClazzInfo info, FSTClazzInfo.FSTFieldInfo referencee)
void	reset()
protected void	resetAndClearRefs()
void	resetForReuse(InputStream in)
void	resetForReuseCopyArray(byte[] bytes, int off, int len)
void	resetForReuseUseArray(byte[] bytes)
void	resetForReuseUseArray(byte[] bytes, int len)
protected void	setCodec(FSTDecoder codec)
void	setConditionalCallback(FSTObjectInput.ConditionalCallback conditionalCallback)
void	setReadExternalReadAHead(int readExternalReadAHead) since the stock readXX methods on InputStream are final, i can't ensure sufficient readAhead on the inputStream before calling readExternal.
void	setVersionConflictListener(VersionConflictListener versionConflictListener) see @Version annotation
long	skip(long n)
int	skipBytes(int n)
protected boolean	skipConditional(Object newObj, int conditional, FSTClazzInfo.FSTFieldInfo subInfo)

Methods inherited from class java.lang.Object

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

Field Detail

REGISTER_ENUMS_READ

public static boolean REGISTER_ENUMS_READ

emptyStream

public static ByteArrayInputStream emptyStream

codec

protected FSTDecoder codec

objects

protected FSTObjectRegistry objects

debugStack

protected Stack<String> debugStack

curDepth

protected int curDepth

callbacks

protected ArrayList<FSTObjectInput.CallbackEntry> callbacks

ignoreAnnotations

protected boolean ignoreAnnotations

clInfoRegistry

protected FSTClazzInfoRegistry clInfoRegistry

conditionalCallback

protected FSTObjectInput.ConditionalCallback conditionalCallback

readExternalReadAHead

protected int readExternalReadAHead

versionConflictListener

protected VersionConflictListener versionConflictListener

conf

protected FSTConfiguration conf

isCrossPlatform

protected boolean isCrossPlatform

infoCache

protected FSTClazzInfo.FSTFieldInfo infoCache

closed

protected boolean closed

fakeWrapper

protected FSTObjectInput.MyObjectStream fakeWrapper

Constructor Detail

FSTObjectInput

public FSTObjectInput()
               throws IOException

Throws:

IOException

FSTObjectInput

public FSTObjectInput(FSTConfiguration conf)

FSTObjectInput

public FSTObjectInput(InputStream in)
               throws IOException

Creates a FSTObjectInput that uses the specified underlying InputStream.

Parameters:

in - the specified input stream

Throws:

IOException

FSTObjectInput

public FSTObjectInput(InputStream in,
                      FSTConfiguration conf)

Creates a FSTObjectInput that uses the specified underlying InputStream. Don't create a FSTConfiguration with each stream, just create one global static configuration and reuseit. FSTConfiguration is threadsafe.

Parameters:

in - the specified input stream

Method Detail

getConf

public FSTConfiguration getConf()

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

getCodec

public FSTDecoder getCodec()

setCodec

protected void setCodec(FSTDecoder codec)

getClassForName

public Class getClassForName(String name)
                      throws ClassNotFoundException

Throws:

ClassNotFoundException

initRegistries

protected void initRegistries(FSTConfiguration conf)

getConditionalCallback

public FSTObjectInput.ConditionalCallback getConditionalCallback()

setConditionalCallback

public void setConditionalCallback(FSTObjectInput.ConditionalCallback conditionalCallback)

getReadExternalReadAHead

public int getReadExternalReadAHead()

setReadExternalReadAHead

public void setReadExternalReadAHead(int readExternalReadAHead)

since the stock readXX methods on InputStream are final, i can't ensure sufficient readAhead on the inputStream before calling readExternal. Default value is 16000 bytes. If you make use of the externalizable interfac and write larger Objects a) cast the ObjectInput in readExternal to FSTObjectInput and call ensureReadAhead on this in your readExternal method b) set a sufficient maximum using this method before serializing.

Parameters:

readExternalReadAHead -

readObject

public Object readObject()
                  throws ClassNotFoundException,
                         IOException

Specified by:

readObject in interface ObjectInput

Throws:

ClassNotFoundException

IOException

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

processValidation

protected void processValidation()
                          throws InvalidObjectException

Throws:

InvalidObjectException

readObject

public Object readObject(Class... possibles)
                  throws Exception

Throws:

Exception

readObjectInternal

public Object readObjectInternal(Class... expected)
                          throws ClassNotFoundException,
                                 IOException,
                                 IllegalAccessException,
                                 InstantiationException

Throws:

ClassNotFoundException

IOException

IllegalAccessException

InstantiationException

readObjectWithHeader

public Object readObjectWithHeader(FSTClazzInfo.FSTFieldInfo referencee)
                            throws Exception

Throws:

Exception

instantiateSpecialTag

protected Object instantiateSpecialTag(FSTClazzInfo.FSTFieldInfo referencee,
                                       int readPos,
                                       byte code)
                                throws Exception

Throws:

Exception

getClazzInfo

protected FSTClazzInfo getClazzInfo(Class c,
                                    FSTClazzInfo.FSTFieldInfo referencee)

instantiateHandle

protected Object instantiateHandle(FSTClazzInfo.FSTFieldInfo referencee)
                            throws IOException

Throws:

IOException

instantiateArray

protected Object instantiateArray(FSTClazzInfo.FSTFieldInfo referencee,
                                  int readPos)
                           throws Exception

Throws:

Exception

instantiateEnum

protected Object instantiateEnum(FSTClazzInfo.FSTFieldInfo referencee,
                                 int readPos)
                          throws IOException,
                                 ClassNotFoundException

Throws:

IOException

ClassNotFoundException

instantiateBigInt

protected Object instantiateBigInt()
                            throws IOException

Throws:

IOException

instantiateAndReadWithSer

protected Object instantiateAndReadWithSer(Class c,
                                           FSTObjectSerializer ser,
                                           FSTClazzInfo clzSerInfo,
                                           FSTClazzInfo.FSTFieldInfo referencee,
                                           int readPos)
                                    throws Exception

Throws:

Exception

instantiateAndReadNoSer

protected Object instantiateAndReadNoSer(Class c,
                                         FSTClazzInfo clzSerInfo,
                                         FSTClazzInfo.FSTFieldInfo referencee,
                                         int readPos)
                                  throws Exception

Throws:

Exception

readObjectCompatible

protected Object readObjectCompatible(FSTClazzInfo.FSTFieldInfo referencee,
                                      FSTClazzInfo serializationInfo,
                                      Object newObj)
                               throws Exception

Throws:

Exception

handleReadRessolve

protected Object handleReadRessolve(FSTClazzInfo serializationInfo,
                                    Object newObj)
                             throws IllegalAccessException

Throws:

IllegalAccessException

readObjectCompatibleRecursive

protected void readObjectCompatibleRecursive(FSTClazzInfo.FSTFieldInfo referencee,
                                             Object toRead,
                                             FSTClazzInfo serializationInfo,
                                             Class cl)
                                      throws Exception

Throws:

Exception

defaultReadObject

public void defaultReadObject(FSTClazzInfo.FSTFieldInfo referencee,
                              FSTClazzInfo serializationInfo,
                              Object newObj)

readObjectFields

protected void readObjectFields(FSTClazzInfo.FSTFieldInfo referencee,
                                FSTClazzInfo serializationInfo,
                                FSTClazzInfo.FSTFieldInfo[] fieldInfo,
                                Object newObj,
                                int startIndex,
                                int version)
                         throws Exception

Throws:

Exception

getVersionConflictListener

public VersionConflictListener getVersionConflictListener()

setVersionConflictListener

public void setVersionConflictListener(VersionConflictListener versionConflictListener)

see @Version annotation

Parameters:

versionConflictListener -

oldVersionRead

protected void oldVersionRead(Object newObj)

readFieldsMapBased

protected void readFieldsMapBased(FSTClazzInfo.FSTFieldInfo referencee,
                                  FSTClazzInfo serializationInfo,
                                  Object newObj)
                           throws Exception

Throws:

Exception

skipConditional

protected boolean skipConditional(Object newObj,
                                  int conditional,
                                  FSTClazzInfo.FSTFieldInfo subInfo)

readCompatibleObjectFields

protected void readCompatibleObjectFields(FSTClazzInfo.FSTFieldInfo referencee,
                                          FSTClazzInfo serializationInfo,
                                          FSTClazzInfo.FSTFieldInfo[] fieldInfo,
                                          Map res)
                                   throws Exception

Throws:

Exception

readStringUTF

public String readStringUTF()
                     throws IOException

Throws:

IOException

readStringAsc

public String readStringAsc()
                     throws IOException

len < 127 !!!!!

Returns:

Throws:

IOException

readArray

protected Object readArray(FSTClazzInfo.FSTFieldInfo referencee)
                    throws Exception

Throws:

Exception

readArrayNoHeader

protected Object readArrayNoHeader(FSTClazzInfo.FSTFieldInfo referencee,
                                   int pos,
                                   Class arrCl)
                            throws Exception

Throws:

Exception

registerObject

public void registerObject(Object o,
                           int streamPosition,
                           FSTClazzInfo info,
                           FSTClazzInfo.FSTFieldInfo referencee)

readClass

public FSTClazzInfo readClass()
                       throws IOException,
                              ClassNotFoundException

Throws:

IOException

ClassNotFoundException

resetAndClearRefs

protected void resetAndClearRefs()

reset

public void reset()
           throws IOException

Throws:

IOException

resetForReuse

public void resetForReuse(InputStream in)
                   throws IOException

Throws:

IOException

resetForReuseCopyArray

public void resetForReuseCopyArray(byte[] bytes,
                                   int off,
                                   int len)
                            throws IOException

Throws:

IOException

resetForReuseUseArray

public void resetForReuseUseArray(byte[] bytes)
                           throws IOException

Throws:

IOException

resetForReuseUseArray

public void resetForReuseUseArray(byte[] bytes,
                                  int len)
                           throws IOException

Throws:

IOException

readFInt

public final int readFInt()
                   throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface ObjectInput

Specified by:

close in interface AutoCloseable

Throws:

IOException

getObjectInputStream

protected ObjectInputStream getObjectInputStream(Class cl,
                                                 FSTClazzInfo clInfo,
                                                 FSTClazzInfo.FSTFieldInfo referencee,
                                                 Object toRead)
                                          throws IOException

Throws:

IOException

pushBack

protected void pushBack(int i)