Package com.fasterxml.jackson.databind
Class SequenceWriter
- java.lang.Object
-
- com.fasterxml.jackson.databind.SequenceWriter
-
- All Implemented Interfaces:
Versioned
,Closeable
,Flushable
,AutoCloseable
public class SequenceWriter extends Object implements Versioned, Closeable, Flushable
Writer class similar toObjectWriter
, 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)
- Since:
- 2.5
-
-
Constructor Summary
Constructors Constructor Description SequenceWriter(DefaultSerializerProvider prov, JsonGenerator gen, boolean closeGenerator, ObjectWriter.Prefetch prefetch)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
void
flush()
SequenceWriter
init(boolean wrapInArray)
Internal method called byObjectWriter
: should not be called by code outsidejackson-databind
classes.Version
version()
Method that will return version information stored in and read from jar that contains this class.SequenceWriter
write(Object value)
Method for writing given value into output, as part of sequence to write.SequenceWriter
write(Object value, JavaType type)
Method for writing given value into output, as part of sequence to write; further, full type (often generic, likeMap
is passed in case a newJsonSerializer
needs to be fetched to handle type If root type was specified forObjectWriter
, value must be of compatible type (same or subtype).<C extends Collection<?>>
SequenceWriterwriteAll(C container)
SequenceWriter
writeAll(Iterable<?> iterable)
SequenceWriter
writeAll(Object[] value)
-
-
-
Constructor Detail
-
SequenceWriter
public SequenceWriter(DefaultSerializerProvider prov, JsonGenerator gen, boolean closeGenerator, ObjectWriter.Prefetch prefetch) throws IOException
- Throws:
IOException
-
-
Method Detail
-
init
public SequenceWriter init(boolean wrapInArray) throws IOException
Internal method called byObjectWriter
: should not be called by code outsidejackson-databind
classes.- Throws:
IOException
-
version
public Version version()
Method that will return version information stored in and read from jar that contains this class.
-
write
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 forObjectWriter
, value must be of compatible type (same or subtype).- Throws:
IOException
-
write
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, likeMap
is passed in case a newJsonSerializer
needs to be fetched to handle type If root type was specified forObjectWriter
, value must be of compatible type (same or subtype).- Throws:
IOException
-
writeAll
public SequenceWriter writeAll(Object[] value) throws IOException
- Throws:
IOException
-
writeAll
public <C extends Collection<?>> SequenceWriter writeAll(C container) throws IOException
- Throws:
IOException
-
writeAll
public SequenceWriter writeAll(Iterable<?> iterable) throws IOException
- Throws:
IOException
- Since:
- 2.7
-
flush
public void flush() throws IOException
- Specified by:
flush
in interfaceFlushable
- Throws:
IOException
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
-