Package com.fasterxml.jackson.datatype.jdk8

Class StreamSerializer

java.lang.Object

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

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

com.fasterxml.jackson.datatype.jdk8.StreamSerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable

public class StreamSerializer
extends StdSerializer<Stream<?>>
implements ContextualSerializer

Common typed stream serializer

See Also:

Serialized Form

Nested Class Summary

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

JsonSerializer.None

Field Summary

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

_handledType

Constructor Summary

Constructors

Constructor	Description
StreamSerializer(JavaType streamType, JavaType elemType)	Constructor
StreamSerializer(JavaType streamType, JavaType elemType, JsonSerializer<Object> elemSerializer)	Constructor with custom serializer

Method Summary

Modifier and Type	Method	Description
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.
void	serialize(Stream<?> stream, JsonGenerator jgen, SerializerProvider provider)	Method that can be called to ask implementation to serialize values of type this serializer handles.

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

_neitherNull, _nonEmpty, acceptJsonFormatVisitor, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamSerializer

public StreamSerializer(JavaType streamType,
                        JavaType elemType)

Constructor

Parameters:

streamType - Stream type

elemType - Stream elements type (matching T)

StreamSerializer

public StreamSerializer(JavaType streamType,
                        JavaType elemType,
                        JsonSerializer<Object> elemSerializer)

Constructor with custom serializer

Parameters:

streamType - Stream type

elemType - Stream elements type (matching T)

elemSerializer - Custom serializer to use for element type

Method Detail

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

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

serialize

public void serialize(Stream<?> stream,
                      JsonGenerator jgen,
                      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.

Specified by:

serialize in class StdSerializer<Stream<?>>

Parameters:

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