jackson-databind 2.16.0 · com.fasterxml.jackson.databind.SequenceWriter

Writer class similar to ObjectWriter, except that it can be used for writing sequences of values, not just a single value. The main use case is in writing very long sequences, or sequences where values are incrementally produced; cases where it would be impractical or at least inconvenient to construct a wrapper container around values (or where no JSON array is desired around values).

Differences from ObjectWriter include:

Instances of SequenceWriter are stateful, and not thread-safe: if sharing, external synchronization must be used.
Explicit close is needed after all values have been written (ObjectWriter can auto-close after individual value writes)

Field Summary

Modifier and Type	Field and Description
protected final boolean	_cfgCloseCloseable
protected final boolean	_cfgFlush
protected boolean	_closed
protected final boolean	_closeGenerator
protected final SerializationConfig	_config
protected PropertySerializerMap	_dynamicSerializers If `_rootSerializer` is not defined (no root type was used for constructing `ObjectWriter`), we will use simple scheme for keeping track of serializers needed.
protected final JsonGenerator	_generator
protected boolean	_openArray State flag for keeping track of need to write matching END_ARRAY, if a START_ARRAY was written during initialization
protected final DefaultSerializerProvider	_provider
protected final JsonSerializer<Object>	_rootSerializer
protected final TypeSerializer	_typeSerializer

Constructor Summary

Access	Constructor and Description
public	SequenceWriter(DefaultSerializerProvider prov, JsonGenerator gen, boolean closeGenerator, ObjectWriter.Prefetch prefetch)

Method Summary

Modifier and Type	Method and Description
private final JsonSerializer<Object>	_findAndAddDynamic(Class<?> type)
private final JsonSerializer<Object>	_findAndAddDynamic(JavaType type)
protected SequenceWriter	_writeCloseableValue(Object value)
protected SequenceWriter	_writeCloseableValue(Object value, JavaType type)
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	flush() Implements java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream.
public SequenceWriter	init(boolean wrapInArray) Internal method called by `ObjectWriter`: should not be called by code outside `jackson-databind` classes.
public Version	version() Implements com.fasterxml.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.
public SequenceWriter	write(Object value) Method for writing given value into output, as part of sequence to write.
public SequenceWriter	write(Object value, JavaType type) Method for writing given value into output, as part of sequence to write; further, full type (often generic, like `java.util.Map` is passed in case a new `JsonSerializer` needs to be fetched to handle type If root type was specified for `ObjectWriter`, value must be of compatible type (same or subtype).
public SequenceWriter	writeAll(Object[] value)
public <C extends Collection<?>> SequenceWriter	writeAll(C container)
public SequenceWriter	writeAll(Iterable<?> iterable)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_cfgCloseCloseable	back to summary
protected final boolean _cfgCloseCloseable

_cfgFlush	back to summary
protected final boolean _cfgFlush

_closed	back to summary
protected boolean _closed

_closeGenerator	back to summary
protected final boolean _closeGenerator

_config	back to summary
protected final SerializationConfig _config

_dynamicSerializers	back to summary
protected PropertySerializerMap _dynamicSerializers If `_rootSerializer` is not defined (no root type was used for constructing `ObjectWriter`), we will use simple scheme for keeping track of serializers needed. Assumption is that

_generator	back to summary
protected final JsonGenerator _generator

_openArray	back to summary
protected boolean _openArray State flag for keeping track of need to write matching END_ARRAY, if a START_ARRAY was written during initialization

_provider	back to summary
protected final DefaultSerializerProvider _provider

_rootSerializer	back to summary
protected final JsonSerializer<Object> _rootSerializer

_typeSerializer	back to summary
protected final TypeSerializer _typeSerializer

Constructor Detail

SequenceWriter	back to summary
public SequenceWriter(DefaultSerializerProvider prov, JsonGenerator gen, boolean closeGenerator, ObjectWriter.Prefetch prefetch) throws IOException

Method Detail

_findAndAddDynamic	back to summary
private final JsonSerializer<Object> _findAndAddDynamic(Class<?> type) throws JsonMappingException

_findAndAddDynamic	back to summary
private final JsonSerializer<Object> _findAndAddDynamic(JavaType type) throws JsonMappingException

_writeCloseableValue	back to summary
protected SequenceWriter _writeCloseableValue(Object value) throws IOException

_writeCloseableValue	back to summary
protected SequenceWriter _writeCloseableValue(Object value, JavaType type) throws IOException

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

flush	back to summary
public void flush() throws IOException Implements java.io.Flushable.flush. Doc from java.io.Flushable.flush. Flushes this stream by writing any buffered output to the underlying stream. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements java.io.Flushable.flush.

Doc from java.io.Flushable.flush.

Flushes this stream by writing any buffered output to the underlying stream.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

init	back to summary
public SequenceWriter init(boolean wrapInArray) throws IOException Internal method called by `ObjectWriter`: should not be called by code outside `jackson-databind` classes.

version	back to summary
public Version version() Implements com.fasterxml.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class. Returns:Version Doc from com.fasterxml.jackson.core.Versioned.version. Version of the component Annotations @Override

version

back to summary

public Version version()

Implements com.fasterxml.jackson.core.Versioned.version.

Method that will return version information stored in and read from jar that contains this class.

Returns:Version

Doc from com.fasterxml.jackson.core.Versioned.version.

Version of the component

Annotations

@Override

write	back to summary
public SequenceWriter write(Object value) throws IOException Method for writing given value into output, as part of sequence to write. If root type was specified for `ObjectWriter`, value must be of compatible type (same or subtype).

write	back to summary
public SequenceWriter write(Object value, JavaType type) throws IOException Method for writing given value into output, as part of sequence to write; further, full type (often generic, like `java.util.Map` is passed in case a new `JsonSerializer` needs to be fetched to handle type If root type was specified for `ObjectWriter`, value must be of compatible type (same or subtype).

writeAll	back to summary
public SequenceWriter writeAll(Object[] value) throws IOException

writeAll	back to summary
public <C extends Collection<?>> SequenceWriter writeAll(C container) throws IOException

writeAll	back to summary
public SequenceWriter writeAll(Iterable<?> iterable) throws IOException Since 2.7

public Class SequenceWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail