Class ReferenceTypeSerializer<T>
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ReferenceTypeSerializer<T>
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,Serializable
- Direct Known Subclasses:
AtomicReferenceSerializer
public abstract class ReferenceTypeSerializer<T>
extends StdSerializer<T>
implements ContextualSerializer
Base implementation for values of
ReferenceType
.
Implements most of functionality, only leaving couple of abstract
methods for sub-classes to implement.- Since:
- 2.8
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
JsonSerializer.None
-
Field Summary
Modifier and TypeFieldDescriptionprotected PropertySerializerMap
If element type cannot be statically determined, mapping from runtime type to serializer is handled using this objectprotected final BeanProperty
protected final JavaType
Value typeprotected final Object
Value that indicates suppression mechanism to use for values contained; either "filter" (of whichequals()
is called), or marker value ofMARKER_FOR_EMPTY
, or null to indicate no filtering for non-null values.protected final boolean
Flag that indicates what to do with `null` values, distinct from handling of_suppressableValue
protected final NameTransformer
In case of unwrapping, need name transformer.protected final JsonSerializer<Object>
Serializer for content values, if statically known.protected final TypeSerializer
Type serializer used for values, if any.static final Object
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
Constructor Summary
ModifierConstructorDescriptionprotected
ReferenceTypeSerializer
(ReferenceTypeSerializer<?> base, BeanProperty property, TypeSerializer vts, JsonSerializer<?> valueSer, NameTransformer unwrapper, Object suppressableValue, boolean suppressNulls) ReferenceTypeSerializer
(ReferenceType fullType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> ser) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract Object
_getReferenced
(T value) protected abstract Object
_getReferencedIfPresent
(T value) protected abstract boolean
_isValuePresent
(T value) Method called to see if there is a value present or not.protected boolean
_useStatic
(SerializerProvider provider, BeanProperty property, JavaType referredType) void
acceptJsonFormatVisitor
(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.createContextual
(SerializerProvider provider, BeanProperty property) Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.boolean
isEmpty
(SerializerProvider provider, T value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).boolean
Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.void
serialize
(T ref, JsonGenerator g, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.void
serializeWithType
(T ref, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.unwrappingSerializer
(NameTransformer transformer) Method that will return serializer instance that produces "unwrapped" serialization, if applicable for type being serialized (which is the case for some serializers that produce JSON Objects as output).abstract ReferenceTypeSerializer<T>
withContentInclusion
(Object suppressableValue, boolean suppressNulls) Mutant factory method called to create a differently constructed instance, specifically with different exclusion rules for contained value.protected abstract ReferenceTypeSerializer<T>
withResolved
(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> valueSer, NameTransformer unwrapper) Mutant factory method called when changes are needed; should construct newly configured instance with new values as indicated.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, properties, replaceDelegatee, usesObjectId, withFilterId
-
Field Details
-
MARKER_FOR_EMPTY
- Since:
- 2.9
-
_referredType
Value type -
_property
-
_valueTypeSerializer
Type serializer used for values, if any. -
_valueSerializer
Serializer for content values, if statically known. -
_unwrapper
In case of unwrapping, need name transformer. -
_dynamicSerializers
If element type cannot be statically determined, mapping from runtime type to serializer is handled using this object -
_suppressableValue
Value that indicates suppression mechanism to use for values contained; either "filter" (of whichequals()
is called), or marker value ofMARKER_FOR_EMPTY
, or null to indicate no filtering for non-null values. Note that inclusion value for Map instance itself is handled by caller (POJO property that refers to the Map value).- Since:
- 2.9
-
_suppressNulls
protected final boolean _suppressNullsFlag that indicates what to do with `null` values, distinct from handling of_suppressableValue
- Since:
- 2.9
-
-
Constructor Details
-
ReferenceTypeSerializer
public ReferenceTypeSerializer(ReferenceType fullType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> ser) -
ReferenceTypeSerializer
protected ReferenceTypeSerializer(ReferenceTypeSerializer<?> base, BeanProperty property, TypeSerializer vts, JsonSerializer<?> valueSer, NameTransformer unwrapper, Object suppressableValue, boolean suppressNulls)
-
-
Method Details
-
unwrappingSerializer
Description copied from class:JsonSerializer
Method that will return serializer instance that produces "unwrapped" serialization, if applicable for type being serialized (which is the case for some serializers that produce JSON Objects as output). If no unwrapped serializer can be constructed, will simply return serializer as-is.Default implementation just returns serializer as-is, indicating that no unwrapped variant exists
- Overrides:
unwrappingSerializer
in classJsonSerializer<T>
- Parameters:
transformer
- Name transformation to use to convert between names of unwrapper properties
-
withResolved
protected abstract ReferenceTypeSerializer<T> withResolved(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> valueSer, NameTransformer unwrapper) Mutant factory method called when changes are needed; should construct newly configured instance with new values as indicated.NOTE: caller has verified that there are changes, so implementations need NOT check if a new instance is needed.
- Since:
- 2.9
-
withContentInclusion
public abstract ReferenceTypeSerializer<T> withContentInclusion(Object suppressableValue, boolean suppressNulls) Mutant factory method called to create a differently constructed instance, specifically with different exclusion rules for contained value.NOTE: caller has verified that there are changes, so implementations need NOT check if a new instance is needed.
- Since:
- 2.9
-
_isValuePresent
Method called to see if there is a value present or not. Note that value itself may still be `null`, even if present, if referential type allows three states (absent, present-null, present-non-null); some only allow two (absent, present-non-null). -
_getReferenced
-
_getReferencedIfPresent
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException Description copied from interface:ContextualSerializer
Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.- Specified by:
createContextual
in interfaceContextualSerializer
- Parameters:
provider
- Serializer provider to use for accessing config, other serializersproperty
- Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)- Returns:
- Serializer to use for serializing values of specified property; may be this instance or a new instance.
- Throws:
JsonMappingException
-
_useStatic
protected boolean _useStatic(SerializerProvider provider, BeanProperty property, JavaType referredType) -
isEmpty
Description copied from class:JsonSerializer
Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).Default implementation will consider only null values to be empty.
NOTE: replaces
JsonSerializer.isEmpty(Object)
, which was deprecated in 2.5- Overrides:
isEmpty
in classJsonSerializer<T>
-
isUnwrappingSerializer
public boolean isUnwrappingSerializer()Description copied from class:JsonSerializer
Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.- Overrides:
isUnwrappingSerializer
in classJsonSerializer<T>
-
getReferredType
- Since:
- 2.9
-
serialize
Description copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serialize
in classStdSerializer<T>
- Parameters:
ref
- Value to serialize; can not be null.g
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
IOException
-
serializeWithType
public void serializeWithType(T ref, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException Description copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.Default implementation will throw
UnsupportedOperationException
to indicate that proper type handling needs to be implemented.For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:
// note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);
and implementations for type serialized as JSON Arrays or Objects would differ slightly, asSTART-ARRAY
/END-ARRAY
andSTART-OBJECT
/END-OBJECT
pairs need to be properly handled with respect to serializing of contents.- Overrides:
serializeWithType
in classJsonSerializer<T>
- Parameters:
ref
- Value to serialize; can not be null.g
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.typeSer
- Type serializer to use for including type information- Throws:
IOException
-
acceptJsonFormatVisitor
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Description copied from class:StdSerializer
Default implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitor
in interfaceJsonFormatVisitable
- Overrides:
acceptJsonFormatVisitor
in classStdSerializer<T>
typeHint
- Type of element (entity like property) being visited- Throws:
JsonMappingException
-