Jackson 2.18.2 · com.fasterxml.jackson.dataformat.csv.impl.CsvEncoder

Field Summary

Modifier and Type	Field and Description
protected BufferedValue[]	_buffered And if output comes in shuffled order we will need to do bit of ordering.
protected boolean	_bufferRecyclable Flag that indicates whether the `_outputBuffer` is recyclable (and needs to be returned to recycler once we are done) or not.
protected final boolean	_cfgAllowsComments
protected boolean	_cfgAlwaysQuoteEmptyStrings
protected boolean	_cfgAlwaysQuoteNumbers
protected boolean	_cfgAlwaysQuoteStrings
protected final char	_cfgColumnSeparator
protected final char	_cfgControlCharEscapeChar
protected final int	_cfgEscapeCharacter
protected boolean	_cfgEscapeControlCharWithEscapeChar
protected boolean	_cfgEscapeQuoteCharWithEscapeChar
protected boolean	_cfgIncludeMissingTail
protected final char[]	_cfgLineSeparator
protected final int	_cfgLineSeparatorLength
protected final int	_cfgMaxQuoteCheckChars
protected final int	_cfgMinSafeChar Lowest-valued character that is safe to output without using quotes around value, NOT including possible escape character.
protected final char[]	_cfgNullValue
protected boolean	_cfgOptimalQuoting Marker flag used to determine if to do optimal (aka "strict") quoting checks or not (looser conservative check)
protected final int	_cfgQuoteCharacter
protected final char	_cfgQuoteCharEscapeChar
protected boolean	_cfgUseFastDoubleWriter
protected int	_charsWritten Let's keep track of how many bytes have been output, may prove useful when debugging.
protected int	_columnCount
protected int	_csvFeatures
protected final IOContext	_ioContext
protected int	_lastBuffered Index of the last buffered value
protected int	_nextColumnToWrite Index of column we expect to write next
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[]	_outputEscapes Currently active set of output escape code definitions (whether and how to escape or not).
protected int	_outputTail Pointer to the next available char position in `_outputBuffer`
protected boolean	_trailingLFRemoved
private static final char[]	FALSE_CHARS
protected static final char[]	HEX_CHARS
protected static final int	MAX_QUOTE_CHECK Also: only do check for optional quotes for short values; longer ones will always be quoted.
protected final BufferedValue[]	NO_BUFFERED
protected static final int	SHORT_WRITE As an optimization we try coalescing short writes into buffer; but pass longer directly.
private static final int[]	sOutputEscapes
private static final char[]	TRUE_CHARS

Constructor Summary

Access	Constructor and Description
public	CsvEncoder(IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema) Deprecated
public	CsvEncoder(IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema, boolean useFastDoubleWriter)
public	CsvEncoder(CsvEncoder base, CsvSchema newSchema)

Method Summary

Modifier and Type	Method and Description
protected void	_append(char[] ch)
private void	_appendCharacterEscape(char ch, int escCode) Method called to append escape sequence for given character, at the end of standard output buffer; or if not possible, write out directly.
protected void	_buffer(int index, BufferedValue v)
private final int	_calcSafeChar()
protected void	_flushBuffer()
private final char	_getQuoteCharEscapeChar(final boolean escapeQuoteCharWithEscapeChar, final int quoteCharacter, final int escapeCharacter)
protected boolean	_mayNeedQuotes(String value, int length, int columnIndex) Helper method that determines whether given String is likely to require quoting; check tries to optimize for speed.
protected final boolean	_needsQuotingLoose(String value)
protected final boolean	_needsQuotingLoose(String value, int esc)
protected boolean	_needsQuotingStrict(String value)
protected boolean	_needsQuotingStrict(String value, int esc)
public void	_releaseBuffers()
private void	_removeTrailingLF()
private final void	_writeLongQuoted(String text, char q)
private final void	_writeLongQuotedAndEscaped(String text, char esc)
public void	_writeQuoted(String text)
protected void	_writeQuoted(String text, char q, int i)
public void	_writeQuotedAndEscaped(String text, char esc)
protected void	_writeQuotedAndEscaped(String text, char q, char esc, int i)
protected void	appendColumnSeparator()
protected void	appendNull()
protected void	appendNumberValue(String numStr)
protected void	appendRawValue(String value)
protected void	appendValue(String value)
protected void	appendValue(int value)
protected void	appendValue(long value)
protected void	appendValue(float value)
protected void	appendValue(double value)
protected void	appendValue(boolean value)
public void	close(boolean autoClose, boolean flushStream)
public void	endRow()
public void	flush(boolean flushStream)
public int	getOutputBuffered() Note while value does indeed indicate amount that has been written in the buffer, there may be more intermediate data that is buffered as values but not yet in buffer.
public Object	getOutputTarget()
public int	nextColumnIndex()
public CsvEncoder	overrideFormatFeatures(int feat)
public CsvEncoder	setOutputEscapes(int[] esc)
public CsvEncoder	withSchema(CsvSchema schema)
public final void	write(int columnIndex, String value)
public final void	write(int columnIndex, char[] ch, int offset, int len)
public final void	write(int columnIndex, int value)
public final void	write(int columnIndex, long value)
public final void	write(int columnIndex, BigInteger value)
public final void	write(int columnIndex, float value)
public final void	write(int columnIndex, double value)
public final void	write(int columnIndex, BigDecimal value, boolean plain)
public final void	write(int columnIndex, boolean value)
public final void	writeColumnName(String name)
public final void	writeNonEscaped(int columnIndex, String rawValue)
public final void	writeNull(int columnIndex)
private void	writeNumber(String text)
public void	writeRaw(String text)
public void	writeRaw(String text, int start, int len)
public void	writeRaw(char[] text, int offset, int len)
public void	writeRaw(char c)
private void	writeRawLong(String text)

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

Field Detail

_buffered	back to summary
protected BufferedValue[] _buffered And if output comes in shuffled order we will need to do bit of ordering.

_bufferRecyclable	back to summary
protected boolean _bufferRecyclable Flag that indicates whether the `_outputBuffer` is recyclable (and needs to be returned to recycler once we are done) or not.

_cfgAllowsComments	back to summary
protected final boolean _cfgAllowsComments

_cfgAlwaysQuoteEmptyStrings	back to summary
protected boolean _cfgAlwaysQuoteEmptyStrings

_cfgAlwaysQuoteNumbers	back to summary
protected boolean _cfgAlwaysQuoteNumbers

_cfgAlwaysQuoteStrings	back to summary
protected boolean _cfgAlwaysQuoteStrings Since 2.5

_cfgColumnSeparator	back to summary
protected final char _cfgColumnSeparator

_cfgControlCharEscapeChar	back to summary
protected final char _cfgControlCharEscapeChar Since 2.9.9

_cfgEscapeCharacter	back to summary
protected final int _cfgEscapeCharacter Since 2.7

_cfgEscapeControlCharWithEscapeChar	back to summary
protected boolean _cfgEscapeControlCharWithEscapeChar Since 2.9.9

_cfgEscapeQuoteCharWithEscapeChar	back to summary
protected boolean _cfgEscapeQuoteCharWithEscapeChar

_cfgIncludeMissingTail	back to summary
protected boolean _cfgIncludeMissingTail Since 2.4

_cfgLineSeparator	back to summary
protected final char[] _cfgLineSeparator

_cfgLineSeparatorLength	back to summary
protected final int _cfgLineSeparatorLength

_cfgMaxQuoteCheckChars	back to summary
protected final int _cfgMaxQuoteCheckChars

_cfgMinSafeChar	back to summary
protected final int _cfgMinSafeChar Lowest-valued character that is safe to output without using quotes around value, NOT including possible escape character.

_cfgNullValue	back to summary
protected final char[] _cfgNullValue Since 2.5

_cfgOptimalQuoting	back to summary
protected boolean _cfgOptimalQuoting Marker flag used to determine if to do optimal (aka "strict") quoting checks or not (looser conservative check) Since 2.4

_cfgOptimalQuoting

back to summary

protected boolean _cfgOptimalQuoting

Marker flag used to determine if to do optimal (aka "strict") quoting checks or not (looser conservative check)

Since: 2.4

_cfgQuoteCharacter	back to summary
protected final int _cfgQuoteCharacter

_cfgQuoteCharEscapeChar	back to summary
protected final char _cfgQuoteCharEscapeChar

_cfgUseFastDoubleWriter	back to summary
protected boolean _cfgUseFastDoubleWriter Since 2.14

_charsWritten	back to summary
protected int _charsWritten Let's keep track of how many bytes have been output, may prove useful when debugging. This does not include bytes buffered in the output buffer, just bytes that have been written using underlying stream writer.

_columnCount	back to summary
protected int _columnCount Since 2.4

_csvFeatures	back to summary
protected int _csvFeatures

_ioContext	back to summary
protected final IOContext _ioContext

_lastBuffered	back to summary
protected int _lastBuffered Index of the last buffered value

_nextColumnToWrite	back to summary
protected int _nextColumnToWrite Index of column we expect to write next

_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`.

_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.

_outputEscapes	back to summary
protected int[] _outputEscapes Currently active set of output escape code definitions (whether and how to escape or not).

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

_trailingLFRemoved	back to summary
protected boolean _trailingLFRemoved

FALSE_CHARS	back to summary
private static final char[] FALSE_CHARS

HEX_CHARS	back to summary
protected static final char[] HEX_CHARS

MAX_QUOTE_CHECK	back to summary
protected static final int MAX_QUOTE_CHECK Also: only do check for optional quotes for short values; longer ones will always be quoted.

NO_BUFFERED	back to summary
protected final BufferedValue[] NO_BUFFERED

SHORT_WRITE	back to summary
protected static final int SHORT_WRITE As an optimization we try coalescing short writes into buffer; but pass longer directly.

sOutputEscapes	back to summary
private static final int[] sOutputEscapes

TRUE_CHARS	back to summary
private static final char[] TRUE_CHARS

Constructor Detail

CsvEncoder	back to summary
public CsvEncoder(IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema) Deprecated Annotations @Deprecated

CsvEncoder	back to summary
public CsvEncoder(IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema, boolean useFastDoubleWriter)

CsvEncoder	back to summary
public CsvEncoder(CsvEncoder base, CsvSchema newSchema)

Method Detail

_append	back to summary
protected void _append(char[] ch) throws IOException

_appendCharacterEscape	back to summary
private void _appendCharacterEscape(char ch, int escCode) throws IOException Method called to append escape sequence for given character, at the end of standard output buffer; or if not possible, write out directly.

_buffer	back to summary
protected void _buffer(int index, BufferedValue v)

_calcSafeChar	back to summary
private final int _calcSafeChar()

_flushBuffer	back to summary
protected void _flushBuffer() throws IOException

_getQuoteCharEscapeChar	back to summary
private final char _getQuoteCharEscapeChar(final boolean escapeQuoteCharWithEscapeChar, final int quoteCharacter, final int escapeCharacter)

_mayNeedQuotes	back to summary
protected boolean _mayNeedQuotes(String value, int length, int columnIndex) Helper method that determines whether given String is likely to require quoting; check tries to optimize for speed.

_needsQuotingLoose	back to summary
protected final boolean _needsQuotingLoose(String value) Since 2.4

_needsQuotingLoose	back to summary
protected final boolean _needsQuotingLoose(String value, int esc)

_needsQuotingStrict	back to summary
protected boolean _needsQuotingStrict(String value) Since 2.4

_needsQuotingStrict	back to summary
protected boolean _needsQuotingStrict(String value, int esc) Since 2.7

_releaseBuffers	back to summary
public void _releaseBuffers()

_removeTrailingLF	back to summary
private void _removeTrailingLF() throws IOException

_writeLongQuoted	back to summary
private final void _writeLongQuoted(String text, char q) throws IOException

_writeLongQuotedAndEscaped	back to summary
private final void _writeLongQuotedAndEscaped(String text, char esc) throws IOException

_writeQuoted	back to summary
public void _writeQuoted(String text) throws IOException

_writeQuoted	back to summary
protected void _writeQuoted(String text, char q, int i) throws IOException

_writeQuotedAndEscaped	back to summary
public void _writeQuotedAndEscaped(String text, char esc) throws IOException

_writeQuotedAndEscaped	back to summary
protected void _writeQuotedAndEscaped(String text, char q, char esc, int i) throws IOException

appendColumnSeparator	back to summary
protected void appendColumnSeparator() throws IOException

appendNull	back to summary
protected void appendNull() throws IOException

appendNumberValue	back to summary
protected void appendNumberValue(String numStr) throws IOException

appendRawValue	back to summary
protected void appendRawValue(String value) throws IOException

appendValue	back to summary
protected void appendValue(String value) throws IOException

appendValue	back to summary
protected void appendValue(int value) throws IOException

appendValue	back to summary
protected void appendValue(long value) throws IOException

appendValue	back to summary
protected void appendValue(float value) throws IOException

appendValue	back to summary
protected void appendValue(double value) throws IOException

appendValue	back to summary
protected void appendValue(boolean value) throws IOException

close	back to summary
public void close(boolean autoClose, boolean flushStream) throws IOException

endRow	back to summary
public void endRow() throws IOException

flush	back to summary
public void flush(boolean flushStream) throws IOException

getOutputBuffered	back to summary
public int getOutputBuffered() Note while value does indeed indicate amount that has been written in the buffer, there may be more intermediate data that is buffered as values but not yet in buffer.

getOutputTarget	back to summary
public Object getOutputTarget()

nextColumnIndex	back to summary
public int nextColumnIndex()

overrideFormatFeatures	back to summary
public CsvEncoder overrideFormatFeatures(int feat)

setOutputEscapes	back to summary
public CsvEncoder setOutputEscapes(int[] esc)

withSchema	back to summary
public CsvEncoder withSchema(CsvSchema schema)

write	back to summary
public final void write(int columnIndex, String value) throws IOException

write	back to summary
public final void write(int columnIndex, char[] ch, int offset, int len) throws IOException

write	back to summary
public final void write(int columnIndex, int value) throws IOException

write	back to summary
public final void write(int columnIndex, long value) throws IOException

write	back to summary
public final void write(int columnIndex, BigInteger value) throws IOException

write	back to summary
public final void write(int columnIndex, float value) throws IOException

write	back to summary
public final void write(int columnIndex, double value) throws IOException

write	back to summary
public final void write(int columnIndex, BigDecimal value, boolean plain) throws IOException

write	back to summary
public final void write(int columnIndex, boolean value) throws IOException

writeColumnName	back to summary
public final void writeColumnName(String name) throws IOException

writeNonEscaped	back to summary
public final void writeNonEscaped(int columnIndex, String rawValue) throws IOException Since 2.5

writeNull	back to summary
public final void writeNull(int columnIndex) throws IOException

writeNumber	back to summary
private void writeNumber(String text) throws IOException

writeRaw	back to summary
public void writeRaw(String text) throws IOException

writeRaw	back to summary
public void writeRaw(String text, int start, int len) throws IOException

writeRaw	back to summary
public void writeRaw(char[] text, int offset, int len) throws IOException

writeRaw	back to summary
public void writeRaw(char c) throws IOException

writeRawLong	back to summary
private void writeRawLong(String text) throws IOException

public Class CsvEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail