com.fasterxml.jackson.core.io

Class SegmentedStringWriter

java.lang.Object

java.io.Writer

com.fasterxml.jackson.core.io.SegmentedStringWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public final class SegmentedStringWriter
extends java.io.Writer

Efficient alternative to StringWriter, based on using segmented internal buffer. Initial input buffer is also recyclable.

This class is most useful when serializing JSON content as a String: if so, instance of this class can be given as the writer to JsonGenerator.

Constructor Summary

Constructors

Constructor and Description
SegmentedStringWriter(BufferRecycler br)

Method Summary

Modifier and Type	Method and Description
java.io.Writer	append(char c)
java.io.Writer	append(java.lang.CharSequence csq)
java.io.Writer	append(java.lang.CharSequence csq, int start, int end)
void	close()
void	flush()
java.lang.String	getAndClear() Main access method that will construct a String that contains all the contents, release all internal buffers we may have, and return result String.
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentedStringWriter

public SegmentedStringWriter(BufferRecycler br)

Method Detail

append

public java.io.Writer append(char c)
                      throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Throws:

java.io.IOException

append

public java.io.Writer append(java.lang.CharSequence csq)
                      throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Throws:

java.io.IOException

append

public java.io.Writer append(java.lang.CharSequence csq,
                             int start,
                             int end)
                      throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Throws:

java.io.IOException

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

flush

public void flush()

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

write

public void write(char[] cbuf)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(int c)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

getAndClear

public java.lang.String getAndClear()
                             throws java.io.IOException

Main access method that will construct a String that contains all the contents, release all internal buffers we may have, and return result String. Note that the method is not idempotent -- if called second time, will just return an empty String.

Returns:

String that contains all aggregated content

Throws:

java.io.IOException - if there are general I/O or parse issues, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)