public class CsvGenerator
extends com.fasterxml.jackson.core.base.GeneratorBase
| Modifier and Type | Class and Description |
|---|---|
static class |
CsvGenerator.Feature
Enumeration that defines all togglable features for CSV writers
(if any: currently none)
|
| Modifier and Type | Field and Description |
|---|---|
protected StringBuilder |
_arrayContents
Accumulated contents of an array cell, if any
|
protected int |
_arrayElements
Additional counter that indicates number of value entries in the
array.
|
protected String |
_arraySeparator
Separator to use during writing of (simple) array value, to be encoded as a
single column value, if any.
|
protected com.fasterxml.jackson.core.io.CharacterEscapes |
_characterEscapes |
protected int |
_formatFeatures
Bit flag composed of bits that indicate which
CsvGenerator.Features
are enabled. |
protected boolean |
_handleFirstLine
Flag that indicates that we need to write header line, if
one is needed.
|
protected com.fasterxml.jackson.core.io.IOContext |
_ioContext |
protected int |
_nextColumnByName
Index of column that we will be getting next, based on
field name call that was made.
|
protected CsvSchema |
_schema
Definition of columns being written, if available.
|
protected boolean |
_skipValue
Flag set when property to write is unknown, and the matching value
is to be skipped quietly.
|
protected SimpleTokenWriteContext |
_skipWithin
When skipping output (for "unknown" output), outermost write context
where skipping should occur
|
protected SimpleTokenWriteContext |
_tokenWriteContext
Current context, in form we can use it (GeneratorBase has
untyped reference; left as null)
|
protected CsvEncoder |
_writer |
protected static long |
MAX_INT_AS_LONG |
protected static long |
MIN_INT_AS_LONG |
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext, DERIVED_FEATURES_MASK, MAX_BIG_DECIMAL_SCALE, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST, WRITE_BINARY, WRITE_BOOLEAN, WRITE_NULL, WRITE_NUMBER, WRITE_RAW, WRITE_STRING| Constructor and Description |
|---|
CsvGenerator(com.fasterxml.jackson.core.io.IOContext ctxt,
int jsonFeatures,
int csvFeatures,
com.fasterxml.jackson.core.ObjectCodec codec,
CsvEncoder csvWriter) |
CsvGenerator(com.fasterxml.jackson.core.io.IOContext ctxt,
int jsonFeatures,
int csvFeatures,
com.fasterxml.jackson.core.ObjectCodec codec,
Writer out,
CsvSchema schema) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
_addToArray(char[] value) |
protected void |
_addToArray(String value) |
protected int |
_columnIndex() |
protected void |
_handleFirstLine() |
protected void |
_releaseBuffers() |
protected void |
_reportMappingError(String msg)
Method called when there is a problem related to mapping data
(compared to a low-level generation); if so, should be surfaced
as
|
protected void |
_verifyValueWrite(String typeMsg) |
boolean |
canOmitFields() |
boolean |
canUseSchema(com.fasterxml.jackson.core.FormatSchema schema) |
boolean |
canWriteFormattedNumbers() |
void |
close() |
CsvGenerator |
configure(CsvGenerator.Feature f,
boolean state) |
CsvGenerator |
disable(CsvGenerator.Feature f) |
CsvGenerator |
enable(CsvGenerator.Feature f) |
protected void |
finishRow()
Method called when the current row is complete; typically
will flush possibly buffered column values, append linefeed
and reset state appropriately.
|
void |
flush() |
com.fasterxml.jackson.core.io.CharacterEscapes |
getCharacterEscapes() |
int |
getFormatFeatures() |
int |
getOutputBuffered()
NOTE: while this method will return some information on amount of data buffered, it
may be an incomplete view as some buffering happens at a higher level, as not-yet-serialized
values.
|
SimpleTokenWriteContext |
getOutputContext() |
Object |
getOutputTarget() |
com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> |
getWriteCapabilities() |
boolean |
isEnabled(CsvGenerator.Feature f) |
com.fasterxml.jackson.core.JsonGenerator |
overrideFormatFeatures(int values,
int mask) |
com.fasterxml.jackson.core.JsonGenerator |
setCharacterEscapes(com.fasterxml.jackson.core.io.CharacterEscapes esc) |
CsvGenerator |
setPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp)
No way (or need) to indent anything, so let's block any attempts.
|
void |
setSchema(com.fasterxml.jackson.core.FormatSchema schema) |
CsvGenerator |
useDefaultPrettyPrinter()
No way (or need) to indent anything, so let's block any attempts.
|
com.fasterxml.jackson.core.Version |
version() |
void |
writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
byte[] data,
int offset,
int len) |
void |
writeBoolean(boolean state) |
void |
writeEndArray() |
void |
writeEndObject() |
void |
writeFieldName(com.fasterxml.jackson.core.SerializableString name) |
void |
writeFieldName(String name) |
void |
writeNull() |
void |
writeNumber(BigDecimal v) |
void |
writeNumber(BigInteger v) |
void |
writeNumber(double v) |
void |
writeNumber(float v) |
void |
writeNumber(int v) |
void |
writeNumber(long v) |
void |
writeNumber(String encodedValue) |
void |
writeOmittedField(String fieldName) |
void |
writeRaw(char c) |
void |
writeRaw(char[] text,
int offset,
int len) |
void |
writeRaw(String text) |
void |
writeRaw(String text,
int offset,
int len) |
void |
writeRawUTF8String(byte[] text,
int offset,
int len) |
void |
writeRawValue(char[] text,
int offset,
int len) |
void |
writeRawValue(String text) |
void |
writeRawValue(String text,
int offset,
int len) |
void |
writeStartArray() |
void |
writeStartObject() |
void |
writeString(char[] text,
int offset,
int len) |
void |
writeString(com.fasterxml.jackson.core.SerializableString sstr) |
void |
writeString(String text) |
void |
writeUTF8String(byte[] text,
int offset,
int len) |
_asString, _checkStdFeatureChanges, _constructDefaultPrettyPrinter, _decodeSurrogate, disable, enable, getCodec, getCurrentValue, getFeatureMask, isClosed, isEnabled, overrideStdFeatures, setCodec, setCurrentValue, setFeatureMask, writeBinary, writeObject, writeRawValue, writeStartObject, writeTree_copyCurrentContents, _reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, canWriteBinaryNatively, canWriteObjectId, canWriteTypeId, configure, copyCurrentEvent, copyCurrentStructure, getHighestEscapedChar, getPrettyPrinter, getSchema, isEnabled, setHighestNonEscapedChar, setRootValueSeparator, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeEmbeddedObject, writeFieldId, writeNullField, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeRaw, writeStartArray, writeStartArray, writeStartArray, writeStartObject, writeString, writeStringField, writeTypeId, writeTypePrefix, writeTypeSuffixprotected static final long MIN_INT_AS_LONG
protected static final long MAX_INT_AS_LONG
protected final com.fasterxml.jackson.core.io.IOContext _ioContext
protected int _formatFeatures
CsvGenerator.Features
are enabled.protected CsvSchema _schema
protected CsvEncoder _writer
protected SimpleTokenWriteContext _tokenWriteContext
protected com.fasterxml.jackson.core.io.CharacterEscapes _characterEscapes
protected boolean _handleFirstLine
protected int _nextColumnByName
protected boolean _skipValue
protected String _arraySeparator
protected StringBuilder _arrayContents
protected int _arrayElements
protected SimpleTokenWriteContext _skipWithin
public CsvGenerator(com.fasterxml.jackson.core.io.IOContext ctxt,
int jsonFeatures,
int csvFeatures,
com.fasterxml.jackson.core.ObjectCodec codec,
Writer out,
CsvSchema schema)
public CsvGenerator(com.fasterxml.jackson.core.io.IOContext ctxt,
int jsonFeatures,
int csvFeatures,
com.fasterxml.jackson.core.ObjectCodec codec,
CsvEncoder csvWriter)
public com.fasterxml.jackson.core.Version version()
version in interface com.fasterxml.jackson.core.Versionedversion in class com.fasterxml.jackson.core.base.GeneratorBasepublic CsvGenerator useDefaultPrettyPrinter()
useDefaultPrettyPrinter in class com.fasterxml.jackson.core.base.GeneratorBasepublic CsvGenerator setPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp)
setPrettyPrinter in class com.fasterxml.jackson.core.JsonGeneratorpublic Object getOutputTarget()
getOutputTarget in class com.fasterxml.jackson.core.JsonGeneratorpublic int getOutputBuffered()
getOutputBuffered in class com.fasterxml.jackson.core.JsonGeneratorpublic SimpleTokenWriteContext getOutputContext()
getOutputContext in class com.fasterxml.jackson.core.base.GeneratorBasepublic void setSchema(com.fasterxml.jackson.core.FormatSchema schema)
setSchema in class com.fasterxml.jackson.core.JsonGeneratorpublic int getFormatFeatures()
getFormatFeatures in class com.fasterxml.jackson.core.JsonGeneratorpublic com.fasterxml.jackson.core.JsonGenerator overrideFormatFeatures(int values,
int mask)
overrideFormatFeatures in class com.fasterxml.jackson.core.JsonGeneratorpublic com.fasterxml.jackson.core.JsonGenerator setCharacterEscapes(com.fasterxml.jackson.core.io.CharacterEscapes esc)
setCharacterEscapes in class com.fasterxml.jackson.core.JsonGeneratorpublic com.fasterxml.jackson.core.io.CharacterEscapes getCharacterEscapes()
getCharacterEscapes in class com.fasterxml.jackson.core.JsonGeneratorpublic boolean canUseSchema(com.fasterxml.jackson.core.FormatSchema schema)
canUseSchema in class com.fasterxml.jackson.core.JsonGeneratorpublic boolean canOmitFields()
canOmitFields in class com.fasterxml.jackson.core.JsonGeneratorpublic boolean canWriteFormattedNumbers()
canWriteFormattedNumbers in class com.fasterxml.jackson.core.JsonGeneratorpublic com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> getWriteCapabilities()
getWriteCapabilities in class com.fasterxml.jackson.core.JsonGeneratorpublic final void writeFieldName(String name) throws IOException
writeFieldName in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic final void writeFieldName(com.fasterxml.jackson.core.SerializableString name)
throws IOException
writeFieldName in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic final boolean isEnabled(CsvGenerator.Feature f)
public CsvGenerator configure(CsvGenerator.Feature f, boolean state)
public CsvGenerator enable(CsvGenerator.Feature f)
public CsvGenerator disable(CsvGenerator.Feature f)
public final void flush()
throws IOException
flush in interface Flushableflush in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableclose in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic final void writeStartArray()
throws IOException
writeStartArray in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic final void writeEndArray()
throws IOException
writeEndArray in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic final void writeStartObject()
throws IOException
writeStartObject in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic final void writeEndObject()
throws IOException
writeEndObject in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeString(String text) throws IOException
writeString in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeString(char[] text,
int offset,
int len)
throws IOException
writeString in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic final void writeString(com.fasterxml.jackson.core.SerializableString sstr)
throws IOException
writeString in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic void writeRawUTF8String(byte[] text,
int offset,
int len)
throws IOException
writeRawUTF8String in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeUTF8String(byte[] text,
int offset,
int len)
throws IOException
writeUTF8String in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeRaw(String text) throws IOException
writeRaw in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeRaw(String text, int offset, int len) throws IOException
writeRaw in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeRaw(char[] text,
int offset,
int len)
throws IOException
writeRaw in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeRaw(char c)
throws IOException
writeRaw in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeRawValue(String text) throws IOException
writeRawValue in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic void writeRawValue(String text, int offset, int len) throws IOException
writeRawValue in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic void writeRawValue(char[] text,
int offset,
int len)
throws IOException
writeRawValue in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionpublic void writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
byte[] data,
int offset,
int len)
throws IOException,
com.fasterxml.jackson.core.JsonGenerationException
writeBinary in class com.fasterxml.jackson.core.JsonGeneratorIOExceptioncom.fasterxml.jackson.core.JsonGenerationExceptionpublic void writeBoolean(boolean state)
throws IOException
writeBoolean in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNull()
throws IOException
writeNull in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(int v)
throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(long v)
throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(BigInteger v) throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(double v)
throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(float v)
throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(BigDecimal v) throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeNumber(String encodedValue) throws IOException
writeNumber in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionpublic void writeOmittedField(String fieldName) throws IOException
writeOmittedField in class com.fasterxml.jackson.core.JsonGeneratorIOExceptionprotected final void _verifyValueWrite(String typeMsg) throws IOException
_verifyValueWrite in class com.fasterxml.jackson.core.base.GeneratorBaseIOExceptionprotected void _releaseBuffers()
_releaseBuffers in class com.fasterxml.jackson.core.base.GeneratorBaseprotected void _reportMappingError(String msg) throws com.fasterxml.jackson.core.JsonProcessingException
com.fasterxml.jackson.core.JsonProcessingExceptionprotected final int _columnIndex()
protected void finishRow()
throws IOException
IOExceptionprotected void _handleFirstLine()
throws IOException
IOExceptionprotected void _addToArray(String value)
protected void _addToArray(char[] value)
Copyright © 2020 FasterXML. All rights reserved.