de.ruedigermoeller.serialization

Class FSTConfiguration

java.lang.Object

de.ruedigermoeller.serialization.FSTConfiguration

public final class FSTConfiguration
extends Object

Created with IntelliJ IDEA. User: ruedi Date: 18.11.12 Time: 20:41 Holds a serialization configuration. Reuse this class !!! construction is very expensive. (just keep a static instances around)

Field Summary

Fields

Modifier and Type	Field and Description
static Integer[]	intObjects

Method Summary

Methods

Modifier and Type	Method and Description
int	calcObjectReadTimeNotAUtility(int iterations, Object obj) for optimization purposes, do not use to benchmark processing time or in a regular program as this methods creates a temporary binaryoutputstream and serializes the object in order to measure the read time in picoseconds.
int	calcObjectSizeBytesNotAUtility(Object obj) for optimization purposes, do not use to benchmark processing time or in a regular program as this methods creates a temporary binaryoutputstream and serializes the object in order to measure the size.
int	calcObjectWriteTimeNotAUtility(int iterations, Object obj) for optimization purposes, do not use to benchmark processing time or in a regular program as this methods creates a temporary binaryoutputstream and serializes the object in order to measure the write time in micros.
static FSTConfiguration	createDefaultConfiguration()
static FSTConfiguration	createStructConfiguration()
Object	getCachedObject(Class cl)
FSTClazzInfo	getClassInfo(Class type)
ClassLoader	getClassLoader() mark the given class as being replaced by a copy of an equal instance.
FSTClazzNameRegistry	getClassRegistry()
FSTClazzInfoRegistry	getCLInfoRegistry()
FSTObjectCopy	getCopier()
static FSTConfiguration	getDefaultConfiguration()
static Integer	getInt(int i)
FSTObjectInput	getObjectInput(byte[] arr, int off, int len) take the given array as input. the array is NOT copied
FSTObjectInput	getObjectInput(InputStream in) utility for thread safety and reuse.
FSTObjectOutput	getObjectOutput(OutputStream out) utility for thread safety and reuse.
boolean	isIgnoreSerialInterfaces()
boolean	isPreferSpeed()
boolean	isShareReferences()
void	registerClass(Class c) attention: id should be > CUSTOM_ID_BASE
void	registerSerializer(Class clazz, FSTObjectSerializer ser, boolean alsoForAllSubclasses)
void	returnObject(Object... cachedObs) reuse heavy weight objects.
void	setIgnoreSerialInterfaces(boolean ignoreSerialInterfaces)
void	setPreferSpeed(boolean preferSpeed) this options lets FST favour speed of encoding over size of the encoded object.
void	setSerializerRegistryDelegate(FSTSerializerRegistryDelegate del) patch default serializer lookup. set to null to delete.
void	setShareReferences(boolean shareReferences) if false, identical objects will get serialized twice.

Methods inherited from class java.lang.Object

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

Field Detail

intObjects

public static Integer[] intObjects

Method Detail

getInt

public static Integer getInt(int i)

getDefaultConfiguration

public static FSTConfiguration getDefaultConfiguration()

createDefaultConfiguration

public static FSTConfiguration createDefaultConfiguration()

registerSerializer

public void registerSerializer(Class clazz,
                      FSTObjectSerializer ser,
                      boolean alsoForAllSubclasses)

createStructConfiguration

public static FSTConfiguration createStructConfiguration()

returnObject

public void returnObject(Object... cachedObs)

reuse heavy weight objects. If a FSTStream is clsoed, objects are returned and can be reused by new stream instances. the objects are held in soft references, so there should be no memory issues

Parameters:

cachedObs -

isPreferSpeed

public boolean isPreferSpeed()

setPreferSpeed

public void setPreferSpeed(boolean preferSpeed)

this options lets FST favour speed of encoding over size of the encoded object. Warning: this option alters the format of the written stream, so both reader and writer should have the same setting, else exceptions will occur

Parameters:

preferSpeed -

calcObjectSizeBytesNotAUtility

public int calcObjectSizeBytesNotAUtility(Object obj)
                                   throws IOException

for optimization purposes, do not use to benchmark processing time or in a regular program as this methods creates a temporary binaryoutputstream and serializes the object in order to measure the size.

Throws:

IOException

setSerializerRegistryDelegate

public void setSerializerRegistryDelegate(FSTSerializerRegistryDelegate del)

patch default serializer lookup. set to null to delete. Should be set prior to any serialization going on (serializer lookup is cached).

Parameters:

del -

calcObjectWriteTimeNotAUtility

public int calcObjectWriteTimeNotAUtility(int iterations,
                                 Object obj)
                                   throws IOException

for optimization purposes, do not use to benchmark processing time or in a regular program as this methods creates a temporary binaryoutputstream and serializes the object in order to measure the write time in micros. give ~50.000 to 100.000 for small objects in order to get accurate results for large objects you can decrease the iterations (give at least 10000)

Throws:

IOException

calcObjectReadTimeNotAUtility

public int calcObjectReadTimeNotAUtility(int iterations,
                                Object obj)
                                  throws Exception

for optimization purposes, do not use to benchmark processing time or in a regular program as this methods creates a temporary binaryoutputstream and serializes the object in order to measure the read time in picoseconds. give ~500.000 to 1.000.000 for small objects in order to get accurate results for large objects you can decrease the iterations (give at least 10000)

Throws:

Exception

getCachedObject

public Object getCachedObject(Class cl)

getCopier

public FSTObjectCopy getCopier()

isShareReferences

public boolean isShareReferences()

setShareReferences

public void setShareReferences(boolean shareReferences)

if false, identical objects will get serialized twice. Gains speed as long there are no double objects/cyclic references (typical for small snippets as used in e.g. RPC)

Parameters:

shareReferences -

registerClass

public void registerClass(Class c)

attention: id should be > CUSTOM_ID_BASE

Parameters:

c -

getClassRegistry

public FSTClazzNameRegistry getClassRegistry()

getCLInfoRegistry

public FSTClazzInfoRegistry getCLInfoRegistry()

getClassLoader

public ClassLoader getClassLoader()

mark the given class as being replaced by a copy of an equal instance. E.g. if A=Dimension(10,10) is written and later on an B=Dimension(10,10) is written, after deserializing B will be copied from A without writing the data of B. This is safe for 99% of the classes e.g. for Number subclasses and String class. See also the EqualnessIsBinary Annotation Note that in addition to equalsness, it is required that A.class == B.class. WARNING: adding collection classes might decrease performance significantly (trade cpu efficiency against size)

getClassInfo

public FSTClazzInfo getClassInfo(Class type)

getObjectInput

public FSTObjectInput getObjectInput(InputStream in)

utility for thread safety and reuse. Do not close the resulting stream. However you should close the given InputStream 'in'

Parameters:

in -

Returns:

getObjectInput

public FSTObjectInput getObjectInput(byte[] arr,
                            int off,
                            int len)

take the given array as input. the array is NOT copied

Parameters:

arr -

off -

len -

Returns:

getObjectOutput

public FSTObjectOutput getObjectOutput(OutputStream out)

utility for thread safety and reuse. Do not close the resulting stream. However you should close the given OutputStream 'out'

Parameters:

out - - can be null (temp bytearrays stream is created then)

Returns:

setIgnoreSerialInterfaces

public void setIgnoreSerialInterfaces(boolean ignoreSerialInterfaces)

isIgnoreSerialInterfaces

public boolean isIgnoreSerialInterfaces()