Class StringArraySerializer
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>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.ContainerSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ArraySerializerBase<String[]>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.impl.StringArraySerializer
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,Serializable
public class StringArraySerializer
extends ArraySerializerBase<String[]>
implements ContextualSerializer
Standard serializer used for
String[]
values.- 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 TypeFieldDescriptionprotected final JsonSerializer<Object>
Value serializer to use, if it's not the standard one (if it is we can optimize serialization a lot)static final StringArraySerializer
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ArraySerializerBase
_property, _unwrapSingle
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
Constructor Summary
ModifierConstructorDescriptionprotected
StringArraySerializer
(StringArraySerializer src, BeanProperty prop, JsonSerializer<?> ser, Boolean unwrapSingle) -
Method Summary
Modifier and TypeMethodDescription_withResolved
(BeanProperty prop, Boolean unwrapSingle) 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.createContextual
(SerializerProvider provider, BeanProperty property) Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.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.Accessor for finding declared (static) element type for type this serializer is used for.getSchema
(SerializerProvider provider, Type typeHint) Default implementation simply claims type is "string"; usually overriden by custom serializers.boolean
hasSingleElement
(String[] value) Method called to determine if the given value (of type handled by this serializer) contains exactly one element.boolean
isEmpty
(SerializerProvider prov, String[] value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).final void
serialize
(String[] value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.void
serializeContents
(String[] value, JsonGenerator gen, SerializerProvider provider) Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ArraySerializerBase
_shouldUnwrapSingle, serializeWithType
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.ContainerSerializer
hasContentTypeAnnotation, withValueTypeSerializer
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
-
Field Details
-
instance
-
_elementSerializer
Value serializer to use, if it's not the standard one (if it is we can optimize serialization a lot)
-
-
Constructor Details
-
StringArraySerializer
protected StringArraySerializer() -
StringArraySerializer
public StringArraySerializer(StringArraySerializer src, BeanProperty prop, JsonSerializer<?> ser, Boolean unwrapSingle)
-
-
Method Details
-
_withResolved
- Specified by:
_withResolved
in classArraySerializerBase<String[]>
-
_withValueTypeSerializer
Strings never add type info; hence, even if type serializer is suggested, we'll ignore it...- Specified by:
_withValueTypeSerializer
in classContainerSerializer<String[]>
-
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 interfaceContextualSerializer
- Overrides:
createContextual
in classArraySerializerBase<String[]>
- Parameters:
provider
- 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
-
getContentType
Description copied from class:ContainerSerializer
Accessor for finding declared (static) element type for type this serializer is used for.- Specified by:
getContentType
in classContainerSerializer<String[]>
-
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 useContainerSerializer.getContentType()
andSerializerProvider.findContentValueSerializer(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty)
.- Specified by:
getContentSerializer
in classContainerSerializer<String[]>
-
isEmpty
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 classJsonSerializer<String[]>
-
hasSingleElement
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
orMap.Entry
instances.- Specified by:
hasSingleElement
in classContainerSerializer<String[]>
-
serialize
public final void serialize(String[] 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.- Overrides:
serialize
in classArraySerializerBase<String[]>
- 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
-
serializeContents
public void serializeContents(String[] value, JsonGenerator gen, SerializerProvider provider) throws IOException - Specified by:
serializeContents
in classArraySerializerBase<String[]>
- Throws:
IOException
-
getSchema
Description copied from class:StdSerializer
Default implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchema
in interfaceSchemaAware
- Overrides:
getSchema
in classStdSerializer<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 interfaceJsonFormatVisitable
- Overrides:
acceptJsonFormatVisitor
in classStdSerializer<String[]>
typeHint
- Type of element (entity like property) being visited- Throws:
JsonMappingException
-