Class StdSerializer<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>
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,Serializable
- Direct Known Subclasses:
BeanSerializerBase
,ByteArraySerializer
,ContainerSerializer
,CoreXMLSerializers.XMLGregorianCalendarSerializer
,DOMSerializer
,FailingSerializer
,JsonValueSerializer
,NullSerializer
,RawSerializer
,ReferenceTypeSerializer
,SerializableSerializer
,StaticListSerializerBase
,StdArraySerializers.CharArraySerializer
,StdDelegatingSerializer
,StdKeySerializer
,StdKeySerializers.Default
,StdKeySerializers.Dynamic
,StdKeySerializers.EnumKeySerializer
,StdKeySerializers.StringKeySerializer
,StdScalarSerializer
,ToEmptyObjectSerializer
,TokenBufferSerializer
,ToStringSerializerBase
,UnsupportedTypeSerializer
public abstract class StdSerializer<T>
extends JsonSerializer<T>
implements JsonFormatVisitable, SchemaAware, Serializable
Base class used by all standard serializers, and can also
be used for custom serializers (in fact, this is the recommended
base class to use).
Provides convenience methods for implementing
SchemaAware
- 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 TypeFieldDescriptionNominal type supported, usually declared type of property for which serializer is used. -
Constructor Summary
ModifierConstructorDescriptionprotected
StdSerializer
(JavaType type) protected
StdSerializer
(StdSerializer<?> src) protected
StdSerializer
(Class<?> t, boolean dummy) Alternate constructor that is (alas!) needed to work around kinks of generic type handlingprotected
StdSerializer
(Class<T> t) -
Method Summary
Modifier and TypeMethodDescriptionprotected static final boolean
_neitherNull
(Object a, Object b) protected static final boolean
_nonEmpty
(Collection<?> c) void
acceptJsonFormatVisitor
(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.protected ObjectNode
createSchemaNode
(String type) protected ObjectNode
createSchemaNode
(String type, boolean isOptional) protected JsonSerializer<?>
findAnnotatedContentSerializer
(SerializerProvider serializers, BeanProperty property) Convenience method for finding out possibly configured content value serializer.protected JsonSerializer<?>
findContextualConvertingSerializer
(SerializerProvider provider, BeanProperty property, JsonSerializer<?> existingSerializer) Helper method that can be used to see if specified property has annotation indicating that a converter is to be used for contained values (contents of structured types; array/List/Map values)protected JsonSerializer<?>
findConvertingContentSerializer
(SerializerProvider provider, BeanProperty prop, JsonSerializer<?> existingSerializer) Deprecated.protected Boolean
findFormatFeature
(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults, JsonFormat.Feature feat) Convenience method that usesfindFormatOverrides(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializerProvider, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty, java.lang.Class<?>)
to find possible defaults and/of overrides, and then callsJsonFormat.Value.getFeature(...)
to find whether that feature has been specifically marked as enabled or disabled.protected JsonFormat.Value
findFormatOverrides
(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults) Helper method that may be used to find if this deserializer has specificJsonFormat
settings, either via property, or through type-specific defaulting.protected JsonInclude.Value
findIncludeOverrides
(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults) protected PropertyFilter
findPropertyFilter
(SerializerProvider provider, Object filterId, Object valueToFilter) Helper method used to locate filter that is needed, based on filter id this serializer was constructed with.getSchema
(SerializerProvider provider, Type typeHint) Default implementation simply claims type is "string"; usually overriden by custom serializers.getSchema
(SerializerProvider provider, Type typeHint, boolean isOptional) Default implementation simply claims type is "string"; usually overriden by custom serializers.Method for accessing type of Objects this serializer can handle.protected boolean
isDefaultSerializer
(JsonSerializer<?> serializer) Method that can be called to determine if given serializer is the default serializer Jackson uses; as opposed to a custom serializer installed by a module or calling application.abstract void
serialize
(T value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.protected void
visitArrayFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonFormatTypes itemType) protected void
visitArrayFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonSerializer<?> itemSerializer, JavaType itemType) protected void
visitFloatFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonParser.NumberType numberType) Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is a floating-point JSON number.protected void
visitIntFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonParser.NumberType numberType) Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON Integer number.protected void
visitIntFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonParser.NumberType numberType, JsonValueFormat format) Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON Integer number, but that there is also a further format restriction involved.protected void
visitStringFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint) Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON String.protected void
visitStringFormat
(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonValueFormat format) Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON String, but that there is a more refined logical typevoid
wrapAndThrow
(SerializerProvider provider, Throwable t, Object bean, int index) void
wrapAndThrow
(SerializerProvider provider, Throwable t, Object bean, String fieldName) Method that will modify caught exception (passed in as argument) as necessary to include reference information, and to ensure it is a subtype ofIOException
, or an unchecked exception.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, serializeWithType, unwrappingSerializer, usesObjectId, withFilterId
-
Field Details
-
_handledType
Nominal type supported, usually declared type of property for which serializer is used.
-
-
Constructor Details
-
StdSerializer
-
StdSerializer
-
StdSerializer
Alternate constructor that is (alas!) needed to work around kinks of generic type handling -
StdSerializer
- Since:
- 2.6
-
-
Method Details
-
handledType
Description copied from class:JsonSerializer
Method for accessing type of Objects this serializer can handle. Note that this information is not guaranteed to be exact -- it may be a more generic (super-type) -- but it should not be incorrect (return a non-related type).Default implementation will return null, which essentially means same as returning
Object.class
would; that is, that nothing is known about handled type.- Overrides:
handledType
in classJsonSerializer<T>
-
serialize
public abstract void serialize(T value, JsonGenerator gen, SerializerProvider provider) throws IOException 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 classJsonSerializer<T>
- Parameters:
value
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
IOException
-
acceptJsonFormatVisitor
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Default implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitor
in interfaceJsonFormatVisitable
- Overrides:
acceptJsonFormatVisitor
in classJsonSerializer<T>
typeHint
- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
getSchema
Default implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchema
in interfaceSchemaAware
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException
-
getSchema
public JsonNode getSchema(SerializerProvider provider, Type typeHint, boolean isOptional) throws JsonMappingException Default implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchema
in interfaceSchemaAware
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.isOptional
- Is the type optional- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException
-
createSchemaNode
-
createSchemaNode
-
visitStringFormat
protected void visitStringFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON String.- Throws:
JsonMappingException
- Since:
- 2.7
-
visitStringFormat
protected void visitStringFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonValueFormat format) throws JsonMappingException Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON String, but that there is a more refined logical type- Throws:
JsonMappingException
- Since:
- 2.7
-
visitIntFormat
protected void visitIntFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonParser.NumberType numberType) throws JsonMappingException Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON Integer number.- Throws:
JsonMappingException
- Since:
- 2.7
-
visitIntFormat
protected void visitIntFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonParser.NumberType numberType, JsonValueFormat format) throws JsonMappingException Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is JSON Integer number, but that there is also a further format restriction involved.- Throws:
JsonMappingException
- Since:
- 2.7
-
visitFloatFormat
protected void visitFloatFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonParser.NumberType numberType) throws JsonMappingException Helper method that calls necessary visit method(s) to indicate that the underlying JSON type is a floating-point JSON number.- Throws:
JsonMappingException
- Since:
- 2.7
-
visitArrayFormat
protected void visitArrayFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonSerializer<?> itemSerializer, JavaType itemType) throws JsonMappingException - Throws:
JsonMappingException
- Since:
- 2.7
-
visitArrayFormat
protected void visitArrayFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonFormatTypes itemType) throws JsonMappingException - Throws:
JsonMappingException
- Since:
- 2.7
-
wrapAndThrow
public void wrapAndThrow(SerializerProvider provider, Throwable t, Object bean, String fieldName) throws IOException Method that will modify caught exception (passed in as argument) as necessary to include reference information, and to ensure it is a subtype ofIOException
, or an unchecked exception.Rules for wrapping and unwrapping are bit complicated; essentially:
- Errors are to be passed as is (if uncovered via unwrapping)
- "Plain" IOExceptions (ones that are not of type
JsonMappingException
are to be passed as is
- Throws:
IOException
-
wrapAndThrow
public void wrapAndThrow(SerializerProvider provider, Throwable t, Object bean, int index) throws IOException - Throws:
IOException
-
findContextualConvertingSerializer
protected JsonSerializer<?> findContextualConvertingSerializer(SerializerProvider provider, BeanProperty property, JsonSerializer<?> existingSerializer) throws JsonMappingException Helper method that can be used to see if specified property has annotation indicating that a converter is to be used for contained values (contents of structured types; array/List/Map values)- Parameters:
existingSerializer
- (optional) configured content serializer if one already exists.- Throws:
JsonMappingException
- Since:
- 2.9
-
findConvertingContentSerializer
@Deprecated protected JsonSerializer<?> findConvertingContentSerializer(SerializerProvider provider, BeanProperty prop, JsonSerializer<?> existingSerializer) throws JsonMappingException Deprecated.- Throws:
JsonMappingException
-
findPropertyFilter
protected PropertyFilter findPropertyFilter(SerializerProvider provider, Object filterId, Object valueToFilter) throws JsonMappingException Helper method used to locate filter that is needed, based on filter id this serializer was constructed with.- Throws:
JsonMappingException
- Since:
- 2.3
-
findFormatOverrides
protected JsonFormat.Value findFormatOverrides(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults) Helper method that may be used to find if this deserializer has specificJsonFormat
settings, either via property, or through type-specific defaulting.- Parameters:
typeForDefaults
- Type (erased) used for finding default format settings, if any- Since:
- 2.7
-
findFormatFeature
protected Boolean findFormatFeature(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults, JsonFormat.Feature feat) Convenience method that usesfindFormatOverrides(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializerProvider, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty, java.lang.Class<?>)
to find possible defaults and/of overrides, and then callsJsonFormat.Value.getFeature(...)
to find whether that feature has been specifically marked as enabled or disabled.- Parameters:
typeForDefaults
- Type (erased) used for finding default format settings, if any- Since:
- 2.7
-
findIncludeOverrides
protected JsonInclude.Value findIncludeOverrides(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults) - Since:
- 2.8
-
findAnnotatedContentSerializer
protected JsonSerializer<?> findAnnotatedContentSerializer(SerializerProvider serializers, BeanProperty property) throws JsonMappingException Convenience method for finding out possibly configured content value serializer.- Throws:
JsonMappingException
- Since:
- 2.7.4
-
isDefaultSerializer
Method that can be called to determine if given serializer is the default serializer Jackson uses; as opposed to a custom serializer installed by a module or calling application. Determination is done usingJacksonStdImpl
annotation on serializer class. -
_neitherNull
- Since:
- 2.9
-
_nonEmpty
- Since:
- 2.9
-
findContextualConvertingSerializer(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializerProvider, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer<?>)
instead