com.fasterxml.jackson.databind.ser.impl

Class StringArraySerializer

java.lang.Object

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

com.fasterxml.jackson.databind.ser.std.StdSerializer<T>

com.fasterxml.jackson.databind.ser.ContainerSerializer<T>

com.fasterxml.jackson.databind.ser.std.ArraySerializerBase<java.lang.String[]>

com.fasterxml.jackson.databind.ser.impl.StringArraySerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, java.io.Serializable

public class StringArraySerializer
extends ArraySerializerBase<java.lang.String[]>
implements ContextualSerializer

Standard serializer used for String[] values.

See Also:

Serialized Form

Nested Class Summary

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

JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field and Description
static StringArraySerializer	instance

Constructor Summary

Constructors

Constructor and Description
StringArraySerializer(StringArraySerializer src, BeanProperty prop, JsonSerializer<?> ser, java.lang.Boolean unwrapSingle)

Method Summary

Modifier and Type	Method and Description
JsonSerializer<?>	_withResolved(BeanProperty prop, java.lang.Boolean unwrapSingle)
ContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts) Strings never add type info; hence, even if type serializer is suggested, we'll ignore it...
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.
JsonSerializer<?>	createContextual(SerializerProvider provider, BeanProperty property) Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
JsonSerializer<?>	getContentSerializer() Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically.
JavaType	getContentType() Accessor for finding declared (static) element type for type this serializer is used for.
JsonNode	getSchema(SerializerProvider provider, java.lang.reflect.Type typeHint) Default implementation simply claims type is "string"; usually overriden by custom serializers.
boolean	hasSingleElement(java.lang.String[] value) Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
boolean	isEmpty(SerializerProvider prov, java.lang.String[] value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
void	serialize(java.lang.String[] value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeContents(java.lang.String[] value, JsonGenerator gen, SerializerProvider provider)

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

serializeWithType

Methods inherited from class com.fasterxml.jackson.databind.ser.ContainerSerializer

withValueTypeSerializer

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

getSchema, handledType, wrapAndThrow, wrapAndThrow

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

getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final StringArraySerializer instance

Constructor Detail

StringArraySerializer

public StringArraySerializer(StringArraySerializer src,
                             BeanProperty prop,
                             JsonSerializer<?> ser,
                             java.lang.Boolean unwrapSingle)

Method Detail

_withResolved

public JsonSerializer<?> _withResolved(BeanProperty prop,
                                       java.lang.Boolean unwrapSingle)

Specified by:

_withResolved in class ArraySerializerBase<java.lang.String[]>

_withValueTypeSerializer

public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Strings never add type info; hence, even if type serializer is suggested, we'll ignore it...

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 interface ContextualSerializer

Overrides:

createContextual in class ArraySerializerBase<java.lang.String[]>

Parameters:

provider - Serializer provider to use for accessing config, other serializers

property - 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

getContentType

public JavaType getContentType()

Description copied from class: ContainerSerializer

Accessor for finding declared (static) element type for type this serializer is used for.

Specified by:

getContentType in class ContainerSerializer<java.lang.String[]>

getContentSerializer

public JsonSerializer<?> getContentSerializer()

Description copied from class: ContainerSerializer

Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically. Note that for dynamic types this may return null; if so, caller has to instead use ContainerSerializer.getContentType() and SerializerProvider.findValueSerializer(java.lang.Class<?>, com.fasterxml.jackson.databind.BeanProperty).

Specified by:

getContentSerializer in class ContainerSerializer<java.lang.String[]>

isEmpty

public boolean isEmpty(SerializerProvider prov,
                       java.lang.String[] value)

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 class JsonSerializer<java.lang.String[]>

hasSingleElement

public boolean hasSingleElement(java.lang.String[] value)

Description copied from class: ContainerSerializer

Method called to determine if the given value (of type handled by this serializer) contains exactly one element.

Note: although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).

Note, too, that as of now (2.9) this method is only called by serializer itself; and specifically is not used for non-array/collection types like Map or Map.Entry instances.

Specified by:

hasSingleElement in class ContainerSerializer<java.lang.String[]>

serialize

public final void serialize(java.lang.String[] value,
                            JsonGenerator gen,
                            SerializerProvider provider)
                     throws java.io.IOException

Description copied from class: JsonSerializer

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

Overrides:

serialize in class ArraySerializerBase<java.lang.String[]>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

provider - Provider that can be used to get serializers for serializing Objects value contains, if any.

Throws:

java.io.IOException

serializeContents

public void serializeContents(java.lang.String[] value,
                              JsonGenerator gen,
                              SerializerProvider provider)
                       throws java.io.IOException

Throws:

java.io.IOException

getSchema

public JsonNode getSchema(SerializerProvider provider,
                          java.lang.reflect.Type typeHint)

Description copied from class: StdSerializer

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

Specified by:

getSchema in interface SchemaAware

Overrides:

getSchema in class StdSerializer<java.lang.String[]>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.

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 interface JsonFormatVisitable

Overrides:

acceptJsonFormatVisitor in class StdSerializer<java.lang.String[]>

typeHint - Type of element (entity like property) being visited

Throws:

JsonMappingException