org.codehaus.jackson.map.ser.std

Class StringCollectionSerializer

java.lang.Object

org.codehaus.jackson.map.JsonSerializer<T>

org.codehaus.jackson.map.ser.std.SerializerBase<T>

org.codehaus.jackson.map.ser.std.StaticListSerializerBase<Collection<String>>

org.codehaus.jackson.map.ser.std.StringCollectionSerializer

All Implemented Interfaces:

ResolvableSerializer, SchemaAware

public class StringCollectionSerializer
extends StaticListSerializerBase<Collection<String>>
implements ResolvableSerializer

Efficient implement for serializing Collections that contain Strings. The only complexity is due to possibility that serializer for String may be overridde; because of this, logic is needed to ensure that the default serializer is in use to use fastest mode, or if not, to defer to custom String serializer.

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonSerializer

JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonSerializer<String>	_serializer

Fields inherited from class org.codehaus.jackson.map.ser.std.StaticListSerializerBase

_property

Fields inherited from class org.codehaus.jackson.map.ser.std.SerializerBase

_handledType

Constructor Summary

Constructors

Constructor and Description
StringCollectionSerializer(BeanProperty property) Deprecated.
StringCollectionSerializer(BeanProperty property, JsonSerializer<?> ser)

Method Summary

Methods

Modifier and Type	Method and Description
protected JsonNode	contentSchema()
void	resolve(SerializerProvider provider) Method called after SerializerProvider has registered the serializer, but before it has returned it to the caller.
void	serialize(Collection<String> value, JsonGenerator jgen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(Collection<String> value, JsonGenerator jgen, 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 org.codehaus.jackson.map.ser.std.StaticListSerializerBase

getSchema

Methods inherited from class org.codehaus.jackson.map.ser.std.SerializerBase

createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow

Methods inherited from class org.codehaus.jackson.map.JsonSerializer

isUnwrappingSerializer, unwrappingSerializer

Methods inherited from class java.lang.Object

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

Field Detail

_serializer

protected JsonSerializer<String> _serializer

Constructor Detail

StringCollectionSerializer

@Deprecated
public StringCollectionSerializer(BeanProperty property)

Deprecated.

StringCollectionSerializer

public StringCollectionSerializer(BeanProperty property,
                          JsonSerializer<?> ser)

Method Detail

contentSchema

protected JsonNode contentSchema()

Specified by:

contentSchema in class StaticListSerializerBase<Collection<String>>

resolve

public void resolve(SerializerProvider provider)
             throws JsonMappingException

Description copied from interface: ResolvableSerializer

Method called after SerializerProvider has registered the serializer, but before it has returned it to the caller. Called object can then resolve its dependencies to other types, including self-references (direct or indirect).

Specified by:

resolve in interface ResolvableSerializer

Parameters:

provider - Provider that has constructed serializer this method is called on.

Throws:

JsonMappingException

serialize

public void serialize(Collection<String> value,
             JsonGenerator jgen,
             SerializerProvider provider)
               throws IOException,
                      JsonGenerationException

Description copied from class: JsonSerializer

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

Specified by:

serialize in class SerializerBase<Collection<String>>

Parameters:

value - Value to serialize; can not be null.

jgen - Generator used to output resulting Json content

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

Throws:

IOException

JsonGenerationException

serializeWithType

public void serializeWithType(Collection<String> value,
                     JsonGenerator jgen,
                     SerializerProvider provider,
                     TypeSerializer typeSer)
                       throws IOException,
                              JsonGenerationException

Description copied from class: JsonSerializer

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.

Default implementation will ignore serialization of type information, and just calls JsonSerializer.serialize(T, org.codehaus.jackson.JsonGenerator, org.codehaus.jackson.map.SerializerProvider): serializers that can embed type information should override this to implement actual handling. Most common such handling is done by something like:

  // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, jgen);
  serialize(value, jgen, provider);
  typeSer.writeTypeSuffixForScalar(value, jgen);

Overrides:

serializeWithType in class JsonSerializer<Collection<String>>

Parameters:

value - Value to serialize; can not be null.

jgen - Generator used to output resulting Json content

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

JsonGenerationException