Jackson 3.0.1 · tools.jackson.databind.ser.SerializerCache

Simple cache object that allows for doing 2-level lookups: first level is by "local" read-only lookup Map (used without locking) and second backup level is by a shared modifiable HashMap. The idea is that after a while, most serializers are found from the local Map (to optimize performance, reduce lock contention), but that during buildup we can use a shared map to reduce both number of distinct read-only maps constructed, and number of serializers constructed.

Cache contains three kinds of entries, based on combination of class pair key. First class in key is for the type to serialize, and second one is type used for determining how to resolve value type. One (but not both) of entries can be null.

Field Summary

Modifier and Type	Field and Description
private final transient AtomicReference<ReadOnlyClassToSerializerMap>	_readOnlyMap Most recent read-only instance, created from _sharedMap, if any.
private final LookupCache<TypeKey, ValueSerializer<Object>>	_sharedMap Shared, modifiable map; used if local read-only copy does not contain serializer caller expects.
public static final int	DEFAULT_MAX_CACHE_SIZE By default, allow caching of up to 4000 serializer entries (for possibly up to 1000 types; but depending access patterns may be as few as half of that).
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	SerializerCache()
public	SerializerCache(int maxCached)
public	SerializerCache(LookupCache<TypeKey, ValueSerializer<Object>> cache)
protected	SerializerCache(SimpleLookupCache<TypeKey, ValueSerializer<Object>> shared)

Method Summary

Modifier and Type	Method and Description
private final synchronized ReadOnlyClassToSerializerMap	_makeReadOnlyLookupMap()
public void	addAndResolveNonTypedSerializer(Class<?> type, ValueSerializer<Object> ser, SerializationContext provider)
public void	addAndResolveNonTypedSerializer(JavaType type, ValueSerializer<Object> ser, SerializationContext provider)
public void	addAndResolveNonTypedSerializer(Class<?> rawType, JavaType fullType, ValueSerializer<Object> ser, SerializationContext provider) Another alternative that will cover both access via raw type and matching fully resolved type, in one fell swoop.
public void	addTypedSerializer(JavaType type, ValueSerializer<Object> ser) Method called if none of lookups succeeded, and caller had to construct a serializer.
public void	addTypedSerializer(Class<?> cls, ValueSerializer<Object> ser)
public synchronized void	flush() Method called by StdSerializationContext#flushCachedSerializers() to clear all cached serializers
public ReadOnlyClassToSerializerMap	getReadOnlyLookupMap() Method that can be called to get a read-only instance populated from the most recent version of the shared lookup Map.
protected Object	readResolve()
public int	size()
public SerializerCache	snapshot() Implements tools.jackson.core.util.Snapshottable.snapshot. Method to call to get an instance that may not be modified through any other object, including `this`.
public ValueSerializer<Object>	typedValueSerializer(JavaType type)
public ValueSerializer<Object>	typedValueSerializer(Class<?> cls)
public ValueSerializer<Object>	untypedValueSerializer(Class<?> type) Method that checks if the shared (and hence, synchronized) lookup Map might have untyped serializer for given type.
public ValueSerializer<Object>	untypedValueSerializer(JavaType type)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_readOnlyMap	back to summary
private final transient AtomicReference<ReadOnlyClassToSerializerMap> _readOnlyMap Most recent read-only instance, created from _sharedMap, if any.

_sharedMap	back to summary
private final LookupCache<TypeKey, ValueSerializer<Object>> _sharedMap Shared, modifiable map; used if local read-only copy does not contain serializer caller expects. Note keys are of various types (see below for key types), in addition to basic `JavaType` used for "untyped" serializers.

DEFAULT_MAX_CACHE_SIZE	back to summary
public static final int DEFAULT_MAX_CACHE_SIZE By default, allow caching of up to 4000 serializer entries (for possibly up to 1000 types; but depending access patterns may be as few as half of that).

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

SerializerCache	back to summary
public SerializerCache()

SerializerCache	back to summary
public SerializerCache(int maxCached) Since 3.0

SerializerCache	back to summary
public SerializerCache(LookupCache<TypeKey, ValueSerializer<Object>> cache)

SerializerCache	back to summary
protected SerializerCache(SimpleLookupCache<TypeKey, ValueSerializer<Object>> shared)

Method Detail

_makeReadOnlyLookupMap	back to summary
private final synchronized ReadOnlyClassToSerializerMap _makeReadOnlyLookupMap()

addAndResolveNonTypedSerializer	back to summary
public void addAndResolveNonTypedSerializer(Class<?> type, ValueSerializer<Object> ser, SerializationContext provider)

addAndResolveNonTypedSerializer	back to summary
public void addAndResolveNonTypedSerializer(JavaType type, ValueSerializer<Object> ser, SerializationContext provider)

addAndResolveNonTypedSerializer	back to summary
public void addAndResolveNonTypedSerializer(Class<?> rawType, JavaType fullType, ValueSerializer<Object> ser, SerializationContext provider) Another alternative that will cover both access via raw type and matching fully resolved type, in one fell swoop.

addTypedSerializer	back to summary
public void addTypedSerializer(JavaType type, ValueSerializer<Object> ser) Method called if none of lookups succeeded, and caller had to construct a serializer. If so, we will update the shared lookup map so that it can be resolved via it next time.

addTypedSerializer	back to summary
public void addTypedSerializer(Class<?> cls, ValueSerializer<Object> ser)

flush	back to summary
public synchronized void flush() Method called by StdSerializationContext#flushCachedSerializers() to clear all cached serializers

getReadOnlyLookupMap	back to summary
public ReadOnlyClassToSerializerMap getReadOnlyLookupMap() Method that can be called to get a read-only instance populated from the most recent version of the shared lookup Map.

readResolve	back to summary
protected Object readResolve()

size	back to summary
public int size()

snapshot	back to summary
public SerializerCache snapshot() Implements tools.jackson.core.util.Snapshottable.snapshot. Doc from tools.jackson.core.util.Snapshottable.snapshot. Method to call to get an instance that may not be modified through any other object, including `this`. That instance may be `this` if (and only if) this instance is effectively immutable (unmodifiable) through its API: if this is not the case, a new copy with same configuration must be created and returned. Annotations @Override

snapshot

back to summary

public SerializerCache snapshot()

Implements tools.jackson.core.util.Snapshottable.snapshot.

Doc from tools.jackson.core.util.Snapshottable.snapshot.

Method to call to get an instance that may not be modified through any other object, including `this`. That instance may be `this` if (and only if) this instance is effectively immutable (unmodifiable) through its API: if this is not the case, a new copy with same configuration must be created and returned.

Annotations

@Override

typedValueSerializer	back to summary
public ValueSerializer<Object> typedValueSerializer(JavaType type)

typedValueSerializer	back to summary
public ValueSerializer<Object> typedValueSerializer(Class<?> cls)

untypedValueSerializer	back to summary
public ValueSerializer<Object> untypedValueSerializer(Class<?> type) Method that checks if the shared (and hence, synchronized) lookup Map might have untyped serializer for given type.

untypedValueSerializer	back to summary
public ValueSerializer<Object> untypedValueSerializer(JavaType type)

public final Class SerializerCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail