jackson-databind 2.16.0 · com.fasterxml.jackson.databind.ser.std.StdSerializer

Modifier and Type	Field and Description
protected final Class<T>	_handledType Nominal type supported, usually declared type of property for which serializer is used.
private static final Object	KEY_CONTENT_CONVERTER_LOCK Key used for storing a lock object to prevent infinite recursion when constructing converting serializers.
private static final long	serialVersionUID

Access	Constructor and Description
protected	StdSerializer(Class<T> t)
protected	StdSerializer(JavaType type)
protected	StdSerializer(Class<?> t, boolean dummy) Alternate constructor that is (alas!) needed to work around kinks of generic type handling
protected	StdSerializer(StdSerializer<?> src) Deprecated as a consequence of `StdSerializer` being deprecated.

Method Summary

Modifier and Type	Method and Description
protected static final boolean	_neitherNull(Object a, Object b)
protected static final boolean	_nonEmpty(Collection<?> c)
public void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType Type of element (entity like property) being visited typeHint) Overrides com.fasterxml.jackson.databind.JsonSerializer.acceptJsonFormatVisitor. Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. 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<?> (optional) configured content serializer if one already exists. 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 Since 2.9 use {link `findContextualConvertingSerializer` instead
protected Boolean	findFormatFeature(SerializerProvider provider, BeanProperty prop, Class<?> Type (erased) used for finding default format settings, if any typeForDefaults, JsonFormat.Feature feat) Convenience method that uses `findFormatOverrides` to find possible defaults and/of overrides, and then calls `JsonFormat.Value.getFeature(...)` to find whether that feature has been specifically marked as enabled or disabled.
protected JsonFormat.Value	findFormatOverrides(SerializerProvider provider, BeanProperty prop, Class<?> Type (erased) used for finding default format settings, if any typeForDefaults) Helper method that may be used to find if this deserializer has specific `JsonFormat` 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.
public JsonNode	getSchema(SerializerProvider The serializer provider. provider, Type A hint about the type. typeHint) Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Deprecated Since 2.15, we recommend use of external JSON Schema generator module Default implementation simply claims type is "string"; usually overriden by custom serializers.
public JsonNode	getSchema(SerializerProvider The serializer provider. provider, Type A hint about the type. typeHint, boolean Is the type optional isOptional) Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Deprecated Since 2.15, we recommend use of external JSON Schema generator module Default implementation simply claims type is "string"; usually overriden by custom serializers.
public Class<T>	handledType() Overrides com.fasterxml.jackson.databind.JsonSerializer.handledType. 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.
public abstract void	serialize(T Value to serialize; can not be null. value, JsonGenerator Generator used to output resulting Json content gen, SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. provider) Implements abstract com.fasterxml.jackson.databind.JsonSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles.
protected void	visitArrayFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonSerializer<?> itemSerializer, JavaType itemType)
protected void	visitArrayFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonFormatTypes 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 type
public 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 of `IOException`, or an unchecked exception.
public void	wrapAndThrow(SerializerProvider provider, Throwable t, Object bean, int index)

Inherited from com.fasterxml.jackson.databind.JsonSerializer:: getDelegatee isEmpty isEmpty isUnwrappingSerializer properties replaceDelegatee serializeWithType unwrappingSerializer usesObjectId withFilterId withIgnoredProperties

_handledType	back to summary
protected final Class<T> _handledType Nominal type supported, usually declared type of property for which serializer is used.

KEY_CONTENT_CONVERTER_LOCK	back to summary
private static final Object KEY_CONTENT_CONVERTER_LOCK Key used for storing a lock object to prevent infinite recursion when constructing converting serializers. Since 2.9

serialVersionUID	back to summary
private static final long serialVersionUID

StdSerializer	back to summary
protected StdSerializer(Class<T> t)

StdSerializer	back to summary
protected StdSerializer(JavaType type) Annotations @SuppressWarnings:unchecked

StdSerializer	back to summary
protected StdSerializer(Class<?> t, boolean dummy) Alternate constructor that is (alas!) needed to work around kinks of generic type handling Annotations @SuppressWarnings:unchecked

StdSerializer	back to summary
protected StdSerializer(StdSerializer<?> src) Deprecated as a consequence of `StdSerializer` being deprecated. See corresponding docs for further information. Annotations @SuppressWarnings:unchecked Since 2.6

Method Detail

_neitherNull	back to summary
protected static final boolean _neitherNull(Object a, Object b) Since 2.9

_nonEmpty	back to summary
protected static final boolean _nonEmpty(Collection<?> c) Since 2.9

acceptJsonFormatVisitor	back to summary
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Overrides com.fasterxml.jackson.databind.JsonSerializer.acceptJsonFormatVisitor. Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Default implementation specifies no format. This behavior is usually overriden by custom serializers. Parameters typeHint:JavaType Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Type of element (entity like property) being visited Annotations @Override

acceptJsonFormatVisitor

back to summary

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.JsonSerializer.acceptJsonFormatVisitor.

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Default implementation specifies no format. This behavior is usually overriden by custom serializers.

Parameters

typeHint:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Type of element (entity like property) being visited

Annotations

@Override

createSchemaNode	back to summary
protected ObjectNode createSchemaNode(String type)

createSchemaNode	back to summary
protected ObjectNode createSchemaNode(String type, boolean isOptional)

findAnnotatedContentSerializer	back to summary
protected JsonSerializer<?> findAnnotatedContentSerializer(SerializerProvider serializers, BeanProperty property) throws JsonMappingException Convenience method for finding out possibly configured content value serializer. Since 2.7.4

findAnnotatedContentSerializer

back to summary

protected JsonSerializer<?> findAnnotatedContentSerializer(SerializerProvider serializers, BeanProperty property) throws JsonMappingException

Convenience method for finding out possibly configured content value serializer.

Since: 2.7.4

findContextualConvertingSerializer	back to summary
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:JsonSerializer<?> (optional) configured content serializer if one already exists. Since 2.9

findContextualConvertingSerializer

back to summary

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:JsonSerializer<?>: (optional) configured content serializer if one already exists.

Since

2.9

findConvertingContentSerializer	back to summary
protected JsonSerializer<?> findConvertingContentSerializer(SerializerProvider provider, BeanProperty prop, JsonSerializer<?> existingSerializer) throws JsonMappingException Deprecated Since 2.9 use {link `findContextualConvertingSerializer` instead Annotations @Deprecated

findFormatFeature back to summary

findFormatFeature	back to summary
protected Boolean findFormatFeature(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults, JsonFormat.Feature feat) Convenience method that uses `findFormatOverrides` to find possible defaults and/of overrides, and then calls `JsonFormat.Value.getFeature(...)` to find whether that feature has been specifically marked as enabled or disabled. Parameters typeForDefaults:Class<?> Type (erased) used for finding default format settings, if any Since 2.7

protected Boolean findFormatFeature(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults, JsonFormat.Feature feat)

Convenience method that uses findFormatOverrides to find possible defaults and/of overrides, and then calls JsonFormat.Value.getFeature(...) to find whether that feature has been specifically marked as enabled or disabled.

Parameters

typeForDefaults:Class<?>: Type (erased) used for finding default format settings, if any

Since

2.7

findFormatOverrides back to summary

findFormatOverrides	back to summary
protected JsonFormat.Value findFormatOverrides(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults) Helper method that may be used to find if this deserializer has specific `JsonFormat` settings, either via property, or through type-specific defaulting. Parameters typeForDefaults:Class<?> Type (erased) used for finding default format settings, if any Since 2.7

protected JsonFormat.Value findFormatOverrides(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults)

Helper method that may be used to find if this deserializer has specific JsonFormat settings, either via property, or through type-specific defaulting.

Parameters

typeForDefaults:Class<?>: Type (erased) used for finding default format settings, if any

Since

2.7

findIncludeOverrides	back to summary
protected JsonInclude.Value findIncludeOverrides(SerializerProvider provider, BeanProperty prop, Class<?> typeForDefaults) Since 2.8

findPropertyFilter	back to summary
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. Since 2.3

findPropertyFilter

back to summary

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.

Since: 2.3

getSchema	back to summary
public JsonNode getSchema(SerializerProvider provider, Type typeHint) throws JsonMappingException Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Deprecated Since 2.15, we recommend use of external JSON Schema generator module Default implementation simply claims type is "string"; usually overriden by custom serializers. Parameters provider:SerializerProvider Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. The serializer provider. typeHint:Type Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. A hint about the type. Returns:JsonNode Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Json-schema for this serializer. Annotations @Deprecated @Override

getSchema

back to summary

public JsonNode getSchema(SerializerProvider provider, Type typeHint) throws JsonMappingException

Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Deprecated

Since 2.15, we recommend use of external JSON Schema generator module

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Parameters

provider:SerializerProvider

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

The serializer provider.

typeHint:Type

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

A hint about the type.

Returns:JsonNode

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Json-schema for this serializer.

Annotations

@Deprecated
@Override

getSchema	back to summary
public JsonNode getSchema(SerializerProvider provider, Type typeHint, boolean isOptional) throws JsonMappingException Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Deprecated Since 2.15, we recommend use of external JSON Schema generator module Default implementation simply claims type is "string"; usually overriden by custom serializers. Parameters provider:SerializerProvider Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. The serializer provider. typeHint:Type Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. A hint about the type. isOptional:boolean Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Is the type optional Returns:JsonNode Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema. Json-schema for this serializer. Annotations @Deprecated @Override

getSchema

back to summary

public JsonNode getSchema(SerializerProvider provider, Type typeHint, boolean isOptional) throws JsonMappingException

Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Deprecated

Since 2.15, we recommend use of external JSON Schema generator module

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Parameters

provider:SerializerProvider

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

The serializer provider.

typeHint:Type

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

A hint about the type.

isOptional:boolean

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Is the type optional

Returns:JsonNode

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Json-schema for this serializer.

Annotations

@Deprecated
@Override

handledType back to summary

handledType	back to summary
public Class<T> handledType() Overrides com.fasterxml.jackson.databind.JsonSerializer.handledType. Doc from com.fasterxml.jackson.databind.JsonSerializer.handledType. 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. Annotations @Override

public Class<T> handledType()

Overrides com.fasterxml.jackson.databind.JsonSerializer.handledType.

Doc from com.fasterxml.jackson.databind.JsonSerializer.handledType.

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.

Annotations

@Override

isDefaultSerializer	back to summary
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. Determination is done using `JacksonStdImpl` annotation on serializer class.

serialize	back to summary
public abstract void serialize(T value, JsonGenerator gen, SerializerProvider provider) throws IOException Implements abstract com.fasterxml.jackson.databind.JsonSerializer.serialize. Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles. Parameters value:T Value to serialize; can not be null. gen:JsonGenerator Generator used to output resulting Json content provider:SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. Annotations @Override

serialize

back to summary

public abstract void serialize(T value, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonSerializer.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

Parameters

value:T: Value to serialize; can not be null.
gen:JsonGenerator: Generator used to output resulting Json content
provider:SerializerProvider: Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations

@Override

visitArrayFormat	back to summary
protected void visitArrayFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonSerializer<?> itemSerializer, JavaType itemType) throws JsonMappingException Since 2.7

visitArrayFormat	back to summary
protected void visitArrayFormat(JsonFormatVisitorWrapper visitor, JavaType typeHint, JsonFormatTypes itemType) throws JsonMappingException Since 2.7

visitFloatFormat	back to summary
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. Since 2.7

visitFloatFormat

back to summary

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.

Since: 2.7

visitIntFormat	back to summary
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. Since 2.7

visitIntFormat

back to summary

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.

Since: 2.7

visitIntFormat	back to summary
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. Since 2.7

visitIntFormat

back to summary

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.

Since: 2.7

visitStringFormat	back to summary
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. Since 2.7

visitStringFormat

back to summary

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.

Since: 2.7

visitStringFormat	back to summary
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 Since 2.7

visitStringFormat

back to summary

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

Since: 2.7

wrapAndThrow back to summary

wrapAndThrow	back to summary
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 of `IOException`, 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

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 of IOException, 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

wrapAndThrow	back to summary
public void wrapAndThrow(SerializerProvider provider, Throwable t, Object bean, int index) throws IOException

public abstract Class StdSerializer<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail