com.fasterxml.jackson.datatype.jdk8

Class OptionalSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<T>

com.fasterxml.jackson.databind.ser.std.StdSerializer<Optional<?>>

com.fasterxml.jackson.datatype.jdk8.OptionalSerializer

All Implemented Interfaces:

com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable, com.fasterxml.jackson.databind.jsonschema.SchemaAware, com.fasterxml.jackson.databind.ser.ContextualSerializer, Serializable

public class OptionalSerializer
extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Optional<?>>
implements com.fasterxml.jackson.databind.ser.ContextualSerializer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

com.fasterxml.jackson.databind.JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.ser.impl.PropertySerializerMap	_dynamicSerializers If element type can not be statically determined, mapping from runtime type to serializer is handled using this object
protected com.fasterxml.jackson.databind.BeanProperty	_property
protected com.fasterxml.jackson.databind.JavaType	_referredType Declared type parameter for Optional.
protected com.fasterxml.jackson.databind.util.NameTransformer	_unwrapper To support unwrapped values of dynamic types, will need this:
protected com.fasterxml.jackson.databind.JsonSerializer<Object>	_valueSerializer

Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Modifier	Constructor and Description
	OptionalSerializer(com.fasterxml.jackson.databind.JavaType type)
protected	OptionalSerializer(com.fasterxml.jackson.databind.JavaType optionalType, com.fasterxml.jackson.databind.JsonSerializer<?> valueSer)
protected	OptionalSerializer(OptionalSerializer base, com.fasterxml.jackson.databind.BeanProperty property, com.fasterxml.jackson.databind.JsonSerializer<?> valueSer, com.fasterxml.jackson.databind.util.NameTransformer unwrapper)

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.databind.JsonSerializer<Object>	_findSerializer(com.fasterxml.jackson.databind.SerializerProvider provider, Class<?> type) Helper method that encapsulates logic of retrieving and caching required serializer.
protected static com.fasterxml.jackson.databind.JavaType	_valueType(com.fasterxml.jackson.databind.JavaType optionalType)
void	acceptJsonFormatVisitor(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper visitor, com.fasterxml.jackson.databind.JavaType typeHint)
com.fasterxml.jackson.databind.JsonSerializer<?>	createContextual(com.fasterxml.jackson.databind.SerializerProvider provider, com.fasterxml.jackson.databind.BeanProperty property)
boolean	isEmpty(Optional<?> value) Deprecated.
boolean	isEmpty(com.fasterxml.jackson.databind.SerializerProvider provider, Optional<?> value)
boolean	isUnwrappingSerializer()
void	serialize(Optional<?> opt, com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider provider)
void	serializeWithType(Optional<?> opt, com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider provider, com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSer)
com.fasterxml.jackson.databind.JsonSerializer<Optional<?>>	unwrappingSerializer(com.fasterxml.jackson.databind.util.NameTransformer transformer)
protected OptionalSerializer	withResolved(com.fasterxml.jackson.databind.BeanProperty prop, com.fasterxml.jackson.databind.JsonSerializer<?> ser, com.fasterxml.jackson.databind.util.NameTransformer unwrapper)

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

createObjectNode, createSchemaNode, createSchemaNode, findConvertingContentSerializer, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

getDelegatee, properties, replaceDelegatee, usesObjectId, withFilterId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_referredType

protected final com.fasterxml.jackson.databind.JavaType _referredType

Declared type parameter for Optional.

_property

protected final com.fasterxml.jackson.databind.BeanProperty _property

_valueSerializer

protected final com.fasterxml.jackson.databind.JsonSerializer<Object> _valueSerializer

_unwrapper

protected final com.fasterxml.jackson.databind.util.NameTransformer _unwrapper

To support unwrapped values of dynamic types, will need this:

_dynamicSerializers

protected transient com.fasterxml.jackson.databind.ser.impl.PropertySerializerMap _dynamicSerializers

If element type can not be statically determined, mapping from runtime type to serializer is handled using this object

Since:

2.6

Constructor Detail

OptionalSerializer

public OptionalSerializer(com.fasterxml.jackson.databind.JavaType type)

OptionalSerializer

protected OptionalSerializer(com.fasterxml.jackson.databind.JavaType optionalType,
                             com.fasterxml.jackson.databind.JsonSerializer<?> valueSer)

OptionalSerializer

protected OptionalSerializer(OptionalSerializer base,
                             com.fasterxml.jackson.databind.BeanProperty property,
                             com.fasterxml.jackson.databind.JsonSerializer<?> valueSer,
                             com.fasterxml.jackson.databind.util.NameTransformer unwrapper)

Method Detail

withResolved

protected OptionalSerializer withResolved(com.fasterxml.jackson.databind.BeanProperty prop,
                                          com.fasterxml.jackson.databind.JsonSerializer<?> ser,
                                          com.fasterxml.jackson.databind.util.NameTransformer unwrapper)

createContextual

public com.fasterxml.jackson.databind.JsonSerializer<?> createContextual(com.fasterxml.jackson.databind.SerializerProvider provider,
                                                                         com.fasterxml.jackson.databind.BeanProperty property)
                                                                  throws com.fasterxml.jackson.databind.JsonMappingException

Specified by:

createContextual in interface com.fasterxml.jackson.databind.ser.ContextualSerializer

Throws:

com.fasterxml.jackson.databind.JsonMappingException

unwrappingSerializer

public com.fasterxml.jackson.databind.JsonSerializer<Optional<?>> unwrappingSerializer(com.fasterxml.jackson.databind.util.NameTransformer transformer)

Overrides:

unwrappingSerializer in class com.fasterxml.jackson.databind.JsonSerializer<Optional<?>>

serialize

public void serialize(Optional<?> opt,
                      com.fasterxml.jackson.core.JsonGenerator gen,
                      com.fasterxml.jackson.databind.SerializerProvider provider)
               throws IOException

Specified by:

serialize in class com.fasterxml.jackson.databind.ser.std.StdSerializer<Optional<?>>

Throws:

IOException

serializeWithType

public void serializeWithType(Optional<?> opt,
                              com.fasterxml.jackson.core.JsonGenerator gen,
                              com.fasterxml.jackson.databind.SerializerProvider provider,
                              com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSer)
                       throws IOException

Overrides:

serializeWithType in class com.fasterxml.jackson.databind.JsonSerializer<Optional<?>>

Throws:

IOException

isEmpty

@Deprecated
public boolean isEmpty(Optional<?> value)

Deprecated.

Overrides:

isEmpty in class com.fasterxml.jackson.databind.JsonSerializer<Optional<?>>

isEmpty

public boolean isEmpty(com.fasterxml.jackson.databind.SerializerProvider provider,
                       Optional<?> value)

Overrides:

isEmpty in class com.fasterxml.jackson.databind.JsonSerializer<Optional<?>>

isUnwrappingSerializer

public boolean isUnwrappingSerializer()

Overrides:

isUnwrappingSerializer in class com.fasterxml.jackson.databind.JsonSerializer<Optional<?>>

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper visitor,
                                    com.fasterxml.jackson.databind.JavaType typeHint)
                             throws com.fasterxml.jackson.databind.JsonMappingException

Specified by:

acceptJsonFormatVisitor in interface com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable

Overrides:

acceptJsonFormatVisitor in class com.fasterxml.jackson.databind.ser.std.StdSerializer<Optional<?>>

Throws:

com.fasterxml.jackson.databind.JsonMappingException

_valueType

protected static com.fasterxml.jackson.databind.JavaType _valueType(com.fasterxml.jackson.databind.JavaType optionalType)

_findSerializer

protected final com.fasterxml.jackson.databind.JsonSerializer<Object> _findSerializer(com.fasterxml.jackson.databind.SerializerProvider provider,
                                                                                      Class<?> type)
                                                                               throws com.fasterxml.jackson.databind.JsonMappingException

Helper method that encapsulates logic of retrieving and caching required serializer.

Throws:

com.fasterxml.jackson.databind.JsonMappingException