FSTConfiguration (fst 2.03 API)

java.lang.Object
- org.nustaq.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)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FSTConfiguration.StreamCoderFactory

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FSTConfiguration.StreamCoderFactory`

Field Summary

Fields
Modifier and Type Field and Description

static Integer[] intObjects

Fields
Modifier and Type	Field and Description
`static Integer[]`	`intObjects`

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`asByteArray(Object object)` convenience.
`Object`	`asObject(byte[] b)` convenience
`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.
`void`	`clearCaches()` clear cached softref's and ThreadLocal.
`static FSTConfiguration`	`createCrossPlatformConfiguration()`
`static FSTConfiguration`	`createDefaultConfiguration()`
`FSTDecoder`	`createStreamDecoder()`
`FSTEncoder`	`createStreamEncoder()`
`static FSTConfiguration`	`createStructConfiguration()`
`<T> T`	`deepCopy(T metadata)`
`Object`	`getCachedObject(Class cl)`
`String`	`getClassForCPName(String name)`
`FSTClazzInfo`	`getClassInfo(Class type)`
`ClassLoader`	`getClassLoader()` mark the given class as being replaced by a copy of an equal instance.
`FSTClazzNameRegistry`	`getClassRegistry()`
`FSTClazzInfo`	`getClazzInfo(Class rowClass)`
`FSTClazzInfoRegistry`	`getCLInfoRegistry()`
`String`	`getCPNameForClass(Class cl)` get cross platform symbolic class identifier
`Integer`	`getCrossPlatformAttributeId(String id)`
`String`	`getCrossPlatformAttributeName(Integer id)`
`byte[]`	`getCrossPlatformBinaryCache(String symbolicName)`
`static FSTConfiguration`	`getDefaultConfiguration()`
`static Integer`	`getInt(int i)`
`FSTObjectInput`	`getObjectInput(byte[] arr)`
`FSTObjectInput`	`getObjectInput(byte[] arr, 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()`
`FSTObjectOutput`	`getObjectOutput(byte[] outByte)`
`FSTObjectOutput`	`getObjectOutput(OutputStream out)` utility for thread safety and reuse.
`FSTConfiguration.StreamCoderFactory`	`getStreamCoderFactory()`
`boolean`	`isCrossPlatform()`
`boolean`	`isForceSerializable()`
`boolean`	`isPreferSpeed()`
`boolean`	`isShareReferences()`
`boolean`	`isStructMode()`
`void`	`registerClass(Class... c)` attention: id should be > CUSTOM_ID_BASE
`void`	`registerCrossPlatformAttributeNames(String... names)` Note: UNUSED, not yet implemented init right after creation of configuration, not during operation as it is not threadsafe regarding mutation
`void`	`registerCrossPlatformClassBinaryCache(String fulLQName, byte[] binary)`
`void`	`registerCrossPlatformClassMapping(String[][] keysAndVals)` init right after creation of configuration, not during operation as it is not threadsafe regarding mutation
`void`	`registerCrossPlatformClassMappingUseSimpleName(Class[] classes)` init right after creation of configuration, not during operation as it is not threadsafe regarding mutation
`void`	`registerCrossPlatformClassMappingUseSimpleName(List<Class> classes)`
`void`	`registerSerializer(Class clazz, FSTObjectSerializer ser, boolean alsoForAllSubclasses)`
`void`	`returnObject(Object cached)` reuse heavy weight objects.
`void`	`setClassLoader(ClassLoader classLoader)`
`void`	`setCrossPlatform(boolean crossPlatform)`
`FSTConfiguration`	`setForceSerializable(boolean forceSerializable)` treat unserializable classes same as if they would be serializable.
`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.
`void`	`setStreamCoderFactory(FSTConfiguration.StreamCoderFactory streamCoderFactory)` allows to use subclassed stream codecs.
`void`	`setStructMode(boolean ignoreSerialInterfaces)` ignores all serialization related interfaces (Serializable, Externalizable) and serializes all classes using the default scheme.

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()
```
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
  - createCrossPlatformConfiguration
```
public static FSTConfiguration createCrossPlatformConfiguration()
```
  - createDefaultConfiguration
```
public static FSTConfiguration createDefaultConfiguration()
```
  - registerSerializer
```
public void registerSerializer(Class clazz,
                      FSTObjectSerializer ser,
                      boolean alsoForAllSubclasses)
```
  - createStructConfiguration
```
public static FSTConfiguration createStructConfiguration()
```
  - getStreamCoderFactory
```
public FSTConfiguration.StreamCoderFactory getStreamCoderFactory()
```
  - setStreamCoderFactory
```
public void setStreamCoderFactory(FSTConfiguration.StreamCoderFactory streamCoderFactory)
```
    allows to use subclassed stream codecs. Can also be used to change class loading behaviour, as clasForName is part of a codec's interface. e.g. new StreamCoderFactory() {
    
    Parameters:
    streamCoderFactory -
  - returnObject
```
public void returnObject(Object cached)
```
    reuse heavy weight objects. If a FSTStream is closed, 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. FIXME: point of contention !
    
    Parameters:
    cached -
  - 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 -
  - getCachedObject
```
public Object getCachedObject(Class cl)
```
  - isForceSerializable
```
public boolean isForceSerializable()
```
  - setForceSerializable
```
public FSTConfiguration setForceSerializable(boolean forceSerializable)
```
    treat unserializable classes same as if they would be serializable.
    
    Parameters:
    forceSerializable -
  - clearCaches
```
public void clearCaches()
```
    clear cached softref's and ThreadLocal. Use if you won't read/write objects anytime soon.
  - 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)
```
  - getObjectInput
```
public FSTObjectInput getObjectInput(byte[] arr,
                            int len)
```
    take the given array as input. the array is NOT copied
    
    Parameters:
    arr -
    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:
  - getObjectOutput
```
public FSTObjectOutput getObjectOutput()
```
    Returns:
    a recycled outputstream reusing its last recently used byte[] buffer
  - getObjectOutput
```
public FSTObjectOutput getObjectOutput(byte[] outByte)
```
  - setStructMode
```
public void setStructMode(boolean ignoreSerialInterfaces)
```
    ignores all serialization related interfaces (Serializable, Externalizable) and serializes all classes using the default scheme. Warning: this is a special mode of operation which fail serializing/deserializing many standard JDK classes.
    
    Parameters:
    ignoreSerialInterfaces -
  - isStructMode
```
public boolean isStructMode()
```
    Returns:
    See Also:
    setStructMode()
  - getClazzInfo
```
public FSTClazzInfo getClazzInfo(Class rowClass)
```
  - setCrossPlatform
```
public void setCrossPlatform(boolean crossPlatform)
```
  - isCrossPlatform
```
public boolean isCrossPlatform()
```
  - deepCopy
```
public <T> T deepCopy(T metadata)
```
  - createStreamEncoder
```
public FSTEncoder createStreamEncoder()
```
  - createStreamDecoder
```
public FSTDecoder createStreamDecoder()
```
  - registerCrossPlatformClassBinaryCache
```
public void registerCrossPlatformClassBinaryCache(String fulLQName,
                                         byte[] binary)
```
  - getCrossPlatformBinaryCache
```
public byte[] getCrossPlatformBinaryCache(String symbolicName)
```
  - registerCrossPlatformClassMapping
```
public void registerCrossPlatformClassMapping(String[][] keysAndVals)
```
    init right after creation of configuration, not during operation as it is not threadsafe regarding mutation
    
    Parameters:
    keysAndVals - { { "symbolicName", "fullQualifiedClazzName" }, .. }
  - registerCrossPlatformClassMappingUseSimpleName
```
public void registerCrossPlatformClassMappingUseSimpleName(Class[] classes)
```
    init right after creation of configuration, not during operation as it is not threadsafe regarding mutation
  - registerCrossPlatformClassMappingUseSimpleName
```
public void registerCrossPlatformClassMappingUseSimpleName(List<Class> classes)
```
  - registerCrossPlatformAttributeNames
```
public void registerCrossPlatformAttributeNames(String... names)
```
    Note: UNUSED, not yet implemented init right after creation of configuration, not during operation as it is not threadsafe regarding mutation
    
    Parameters:
    names - { "varName", .. } for each of these an id will be written instead of full name.
  - getCrossPlatformAttributeName
```
public String getCrossPlatformAttributeName(Integer id)
```
  - getCrossPlatformAttributeId
```
public Integer getCrossPlatformAttributeId(String id)
```
  - getCPNameForClass
```
public String getCPNameForClass(Class cl)
```
    get cross platform symbolic class identifier
    
    Parameters:
    cl -
    
    Returns:
  - getClassForCPName
```
public String getClassForCPName(String name)
```
  - asObject
```
public Object asObject(byte[] b)
```
    convenience
  - asByteArray
```
public byte[] asByteArray(Object object)
```
    convenience. (object must be serialiable unless fstconfiguration with appropriate settings is used)

Class FSTConfiguration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

intObjects

Method Detail

getInt

getDefaultConfiguration

setClassLoader

createCrossPlatformConfiguration

createDefaultConfiguration

registerSerializer

createStructConfiguration

getStreamCoderFactory

setStreamCoderFactory

returnObject

isPreferSpeed

setPreferSpeed

calcObjectSizeBytesNotAUtility

setSerializerRegistryDelegate

getCachedObject

isForceSerializable

setForceSerializable

clearCaches

isShareReferences

setShareReferences

registerClass

getClassRegistry

getCLInfoRegistry

getClassLoader

getClassInfo

getObjectInput

getObjectInput

getObjectInput

getObjectOutput

getObjectOutput

getObjectOutput

setStructMode

isStructMode

getClazzInfo

setCrossPlatform

isCrossPlatform

deepCopy

createStreamEncoder

createStreamDecoder

registerCrossPlatformClassBinaryCache

getCrossPlatformBinaryCache

registerCrossPlatformClassMapping

registerCrossPlatformClassMappingUseSimpleName

registerCrossPlatformClassMappingUseSimpleName

registerCrossPlatformAttributeNames

getCrossPlatformAttributeName

getCrossPlatformAttributeId

getCPNameForClass

getClassForCPName

asObject

asByteArray