Jackson 3.0.1 · tools.jackson.dataformat.javaprop.impl.WriterBackedGenerator

Field Summary

Modifier and Type	Field and Description
protected final Writer	_out Underlying `Writer` used for output.
protected char[]	_outputBuffer Intermediate buffer in which contents are buffered before being written using `_out`.
protected final int	_outputEnd Offset to index after the last valid index in `_outputBuffer`.
protected int	_outputTail Pointer to the next available location in `_outputBuffer`

Modifier and Type

Field and Description

protected final Writer

_out

Underlying Writer used for output.

protected char[]

_outputBuffer

Intermediate buffer in which contents are buffered before being written using _out.

protected final int

_outputEnd

Offset to index after the last valid index in _outputBuffer.

protected int

_outputTail

Pointer to the next available location in _outputBuffer

Access	Constructor and Description
public	WriterBackedGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int stdFeatures, JavaPropsSchema schema, Writer out)

Access

Constructor and Description

public

WriterBackedGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int stdFeatures, JavaPropsSchema schema, Writer out)

Modifier and Type	Method and Description
protected void	_appendPropertyName(StringBuilder path, String name) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._appendPropertyName.
protected void	_closeInput() Implements abstract tools.jackson.core.base.GeneratorBase._closeInput.
protected void	_flushBuffer()
protected void	_releaseBuffers() Implements abstract tools.jackson.core.base.GeneratorBase._releaseBuffers. Method called to release any buffers generator may be holding, once generator is being closed.
protected void	_writeEscaped(String value)
protected void	_writeEscaped(char[] text, int offset, int len)
protected void	_writeEscapedEntry(String value) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry.
protected void	_writeEscapedEntry(char[] text, int offset, int len) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry.
protected void	_writeLinefeed()
protected void	_writeRaw(char c) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.
protected void	_writeRaw(String text) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.
protected void	_writeRaw(StringBuilder text) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.
protected void	_writeRaw(char[] text, int offset, int len) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.
protected void	_writeRawLong(String text)
protected void	_writeRawLong(StringBuilder text)
protected void	_writeUnescapedEntry(String value) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeUnescapedEntry.
public void	close() Overrides tools.jackson.core.base.GeneratorBase.close. Implements java.io.Closeable.close. Method called to close this generator, so that no more content can be written.
public void	flush() Implements abstract tools.jackson.core.JsonGenerator.flush. Implements java.io.Flushable.flush. Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
public int	streamWriteOutputBuffered() Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputBuffered. Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available.
public Object	streamWriteOutputTarget() Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputTarget. Method that can be used to get access to object that is used as target for generated output; this is usually either `java.io.OutputStream` or `java.io.Writer`, depending on what generator was constructed with.

Modifier and Type

Method and Description

protected void

_appendPropertyName(StringBuilder path, String name)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._appendPropertyName.

protected void

_closeInput()

Implements abstract tools.jackson.core.base.GeneratorBase._closeInput.

protected void

_flushBuffer()

protected void

_releaseBuffers()

Implements abstract tools.jackson.core.base.GeneratorBase._releaseBuffers.

Method called to release any buffers generator may be holding, once generator is being closed.

protected void

_writeEscaped(String value)

protected void

_writeEscaped(char[] text, int offset, int len)

protected void

_writeEscapedEntry(String value)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry.

protected void

_writeEscapedEntry(char[] text, int offset, int len)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry.

protected void

_writeLinefeed()

protected void

_writeRaw(char c)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

protected void

_writeRaw(String text)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

protected void

_writeRaw(StringBuilder text)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

protected void

_writeRaw(char[] text, int offset, int len)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

protected void

_writeRawLong(String text)

protected void

_writeRawLong(StringBuilder text)

protected void

_writeUnescapedEntry(String value)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeUnescapedEntry.

public void

close()

Overrides tools.jackson.core.base.GeneratorBase.close.

Implements java.io.Closeable.close.

Method called to close this generator, so that no more content can be written.

public void

flush()

Implements abstract tools.jackson.core.JsonGenerator.flush.

Implements java.io.Flushable.flush.

Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.

public int

streamWriteOutputBuffered()

Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputBuffered.

public Object

streamWriteOutputTarget()

Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputTarget.

Field Detail

_out	back to summary
protected final Writer _out Underlying `Writer` used for output.

_out

back to summary

protected final Writer _out

Underlying Writer used for output.

_outputBuffer	back to summary
protected char[] _outputBuffer Intermediate buffer in which contents are buffered before being written using `_out`.

_outputBuffer

back to summary

protected char[] _outputBuffer

Intermediate buffer in which contents are buffered before being written using _out.

_outputEnd	back to summary
protected final int _outputEnd Offset to index after the last valid index in `_outputBuffer`. Typically same as length of the buffer.

_outputEnd

back to summary

protected final int _outputEnd

Offset to index after the last valid index in _outputBuffer. Typically same as length of the buffer.

_outputTail	back to summary
protected int _outputTail Pointer to the next available location in `_outputBuffer`

_outputTail

back to summary

protected int _outputTail

Pointer to the next available location in _outputBuffer

WriterBackedGenerator	back to summary
public WriterBackedGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int stdFeatures, JavaPropsSchema schema, Writer out)

WriterBackedGenerator

back to summary

public WriterBackedGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int stdFeatures, JavaPropsSchema schema, Writer out)

Method Detail

_appendPropertyName	back to summary
protected void _appendPropertyName(StringBuilder path, String name) Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._appendPropertyName. Annotations @Override

_appendPropertyName

back to summary

protected void _appendPropertyName(StringBuilder path, String name)

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._appendPropertyName.

Annotations

@Override

_closeInput	back to summary
protected void _closeInput() throws IOException Implements abstract tools.jackson.core.base.GeneratorBase._closeInput. Annotations @Override

_closeInput

back to summary

protected void _closeInput() throws IOException

Implements abstract tools.jackson.core.base.GeneratorBase._closeInput.

Annotations

@Override

_flushBuffer	back to summary
protected void _flushBuffer() throws JacksonException

_releaseBuffers	back to summary
protected void _releaseBuffers() Implements abstract tools.jackson.core.base.GeneratorBase._releaseBuffers. Doc from tools.jackson.core.base.GeneratorBase._releaseBuffers. Method called to release any buffers generator may be holding, once generator is being closed. Annotations @Override

_releaseBuffers

back to summary

protected void _releaseBuffers()

Implements abstract tools.jackson.core.base.GeneratorBase._releaseBuffers.

Doc from tools.jackson.core.base.GeneratorBase._releaseBuffers.

Method called to release any buffers generator may be holding, once generator is being closed.

Annotations

@Override

_writeEscaped	back to summary
protected void _writeEscaped(String value) throws JacksonException

_writeEscaped	back to summary
protected void _writeEscaped(char[] text, int offset, int len) throws JacksonException

_writeEscapedEntry	back to summary
protected void _writeEscapedEntry(String value) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry. Annotations @Override

_writeEscapedEntry

back to summary

protected void _writeEscapedEntry(String value) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry.

Annotations

@Override

_writeEscapedEntry	back to summary
protected void _writeEscapedEntry(char[] text, int offset, int len) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry. Annotations @Override

_writeEscapedEntry

back to summary

protected void _writeEscapedEntry(char[] text, int offset, int len) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeEscapedEntry.

Annotations

@Override

_writeLinefeed	back to summary
protected void _writeLinefeed() throws JacksonException

_writeRaw	back to summary
protected void _writeRaw(char c) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw. Annotations @Override

_writeRaw

back to summary

protected void _writeRaw(char c) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

Annotations

@Override

_writeRaw	back to summary
protected void _writeRaw(String text) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw. Annotations @Override

_writeRaw

back to summary

protected void _writeRaw(String text) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

Annotations

@Override

_writeRaw	back to summary
protected void _writeRaw(StringBuilder text) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw. Annotations @Override

_writeRaw

back to summary

protected void _writeRaw(StringBuilder text) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

Annotations

@Override

_writeRaw	back to summary
protected void _writeRaw(char[] text, int offset, int len) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw. Annotations @Override

_writeRaw

back to summary

protected void _writeRaw(char[] text, int offset, int len) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeRaw.

Annotations

@Override

_writeRawLong	back to summary
protected void _writeRawLong(String text) throws JacksonException

_writeRawLong	back to summary
protected void _writeRawLong(StringBuilder text) throws JacksonException

_writeUnescapedEntry	back to summary
protected void _writeUnescapedEntry(String value) throws JacksonException Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeUnescapedEntry. Annotations @Override

_writeUnescapedEntry

back to summary

protected void _writeUnescapedEntry(String value) throws JacksonException

Implements abstract tools.jackson.dataformat.javaprop.JavaPropsGenerator._writeUnescapedEntry.

Annotations

@Override

close back to summary

close	back to summary
public void close() Overrides tools.jackson.core.base.GeneratorBase.close. Implements java.io.Closeable.close. Doc from tools.jackson.core.JsonGenerator.close. Method called to close this generator, so that no more content can be written. Whether the underlying target (stream, writer) gets closed depends on whether this generator either manages the target (i.e. is the only one with access to the target -- case if caller passes a reference to the resource such as File, but not stream); or has feature `StreamWriteFeature#AUTO_CLOSE_TARGET` enabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed. Annotations @Override

public void close()

Overrides tools.jackson.core.base.GeneratorBase.close.

Implements java.io.Closeable.close.

Doc from tools.jackson.core.JsonGenerator.close.

Method called to close this generator, so that no more content can be written.

Whether the underlying target (stream, writer) gets closed depends on whether this generator either manages the target (i.e. is the only one with access to the target -- case if caller passes a reference to the resource such as File, but not stream); or has feature StreamWriteFeature#AUTO_CLOSE_TARGET enabled. If either of above is true, the target is also closed. Otherwise (not managing, feature not enabled), target is not closed.

Annotations

@Override

flush	back to summary
public void flush() Implements abstract tools.jackson.core.JsonGenerator.flush. Implements java.io.Flushable.flush. Doc from tools.jackson.core.JsonGenerator.flush. Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well. Annotations @Override

flush

back to summary

public void flush()

Implements abstract tools.jackson.core.JsonGenerator.flush.

Implements java.io.Flushable.flush.

Doc from tools.jackson.core.JsonGenerator.flush.

Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.

Annotations

@Override

streamWriteOutputBuffered back to summary

streamWriteOutputBuffered	back to summary
public int streamWriteOutputBuffered() Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputBuffered. Doc from tools.jackson.core.JsonGenerator.streamWriteOutputBuffered. Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available. Unit used is often the same as the unit of underlying target (that is, `byte` for `java.io.OutputStream`, `char` for `java.io.Writer`), but may differ if buffering is done before encoding. Default JSON-backed implementations do use matching units. Note was named `getOutputBuffered()` in Jackson 2.x. Annotations @Override

public int streamWriteOutputBuffered()

Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputBuffered.

Doc from tools.jackson.core.JsonGenerator.streamWriteOutputBuffered.

Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available. Unit used is often the same as the unit of underlying target (that is, byte for java.io.OutputStream, char for java.io.Writer), but may differ if buffering is done before encoding. Default JSON-backed implementations do use matching units.

Note

was named getOutputBuffered() in Jackson 2.x.

Annotations

@Override

streamWriteOutputTarget back to summary

streamWriteOutputTarget	back to summary
public Object streamWriteOutputTarget() Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputTarget. Doc from tools.jackson.core.JsonGenerator.streamWriteOutputTarget. Method that can be used to get access to object that is used as target for generated output; this is usually either `java.io.OutputStream` or `java.io.Writer`, depending on what generator was constructed with. Note that returned value may be null in some cases; including case where implementation does not want to exposed raw source to caller. In cases where output has been decorated, object returned here is the decorated version; this allows some level of interaction between users of generator and decorator object. In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable. Note was named `getOutputTarget()` in Jackson 2.x. Annotations @Override

public Object streamWriteOutputTarget()

Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputTarget.

Doc from tools.jackson.core.JsonGenerator.streamWriteOutputTarget.

Method that can be used to get access to object that is used as target for generated output; this is usually either java.io.OutputStream or java.io.Writer, depending on what generator was constructed with. Note that returned value may be null in some cases; including case where implementation does not want to exposed raw source to caller. In cases where output has been decorated, object returned here is the decorated version; this allows some level of interaction between users of generator and decorator object.

In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

Note

was named getOutputTarget() in Jackson 2.x.

Annotations

@Override

public Class WriterBackedGenerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail