Class StaticListSerializerBase<T extends Collection<?>>
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StaticListSerializerBase<T>
-
- All Implemented Interfaces:
JsonFormatVisitable,SchemaAware,ContextualSerializer,Serializable
- Direct Known Subclasses:
IndexedStringListSerializer,StringCollectionSerializer
public abstract class StaticListSerializerBase<T extends Collection<?>> extends StdSerializer<T> implements ContextualSerializer
Intermediate base class for Lists, Collections and Arrays that contain static (non-dynamic) value types.- 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 Description protected Boolean_unwrapSingleSetting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedStaticListSerializerBase(StaticListSerializerBase<?> src, Boolean unwrapSingle)protectedStaticListSerializerBase(Class<?> cls)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract JsonSerializer<?>_withResolved(BeanProperty prop, Boolean unwrapSingle)protected abstract voidacceptContentVisitor(JsonArrayFormatVisitor visitor)voidacceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)Default implementation specifies no format.protected abstract JsonNodecontentSchema()JsonSerializer<?>createContextual(SerializerProvider serializers, BeanProperty property)Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.JsonNodegetSchema(SerializerProvider provider, Type typeHint)Default implementation simply claims type is "string"; usually overriden by custom serializers.booleanisEmpty(SerializerProvider provider, T value)Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).abstract voidserializeWithType(T value, com.fasterxml.jackson.core.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.-
Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, serialize, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
-
Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
-
-
-
-
Field Detail
-
_unwrapSingle
protected final Boolean _unwrapSingle
Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.- Since:
- 2.6
-
-
Constructor Detail
-
StaticListSerializerBase
protected StaticListSerializerBase(Class<?> cls)
-
StaticListSerializerBase
protected StaticListSerializerBase(StaticListSerializerBase<?> src, Boolean unwrapSingle)
- Since:
- 2.9
-
-
Method Detail
-
_withResolved
public abstract JsonSerializer<?> _withResolved(BeanProperty prop, Boolean unwrapSingle)
- Since:
- 2.9
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException
Description copied from interface:ContextualSerializerMethod 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:
createContextualin interfaceContextualSerializer- Parameters:
serializers- 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
-
isEmpty
public boolean isEmpty(SerializerProvider provider, T value)
Description copied from class:JsonSerializerMethod 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:
isEmptyin classJsonSerializer<T extends Collection<?>>
-
getSchema
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
Description copied from class:StdSerializerDefault implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchemain interfaceSchemaAware- Overrides:
getSchemain classStdSerializer<T extends Collection<?>>- 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:StdSerializerDefault implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitorin interfaceJsonFormatVisitable- Overrides:
acceptJsonFormatVisitorin classStdSerializer<T extends Collection<?>>typeHint- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
contentSchema
protected abstract JsonNode contentSchema()
-
acceptContentVisitor
protected abstract void acceptContentVisitor(JsonArrayFormatVisitor visitor) throws JsonMappingException
- Throws:
JsonMappingException
-
serializeWithType
public abstract void serializeWithType(T value, com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException
Description copied from class:JsonSerializerMethod 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
UnsupportedOperationExceptionto 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-ARRAYandSTART-OBJECT/END-OBJECTpairs need to be properly handled with respect to serializing of contents.- Overrides:
serializeWithTypein classJsonSerializer<T extends Collection<?>>- Parameters:
value- 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
-
-