com.fasterxml.jackson.dataformat.csv

Class CsvFactory

java.lang.Object

com.fasterxml.jackson.core.JsonFactory

com.fasterxml.jackson.dataformat.csv.CsvFactory

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, Serializable

public class CsvFactory
extends com.fasterxml.jackson.core.JsonFactory

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonFactory

com.fasterxml.jackson.core.JsonFactory.Feature

Field Summary

Fields

Modifier and Type	Field and Description
protected char	_cfgColumnSeparator
protected char[]	_cfgLineSeparator
protected char	_cfgQuoteCharacter
protected int	_csvGeneratorFeatures
protected int	_csvParserFeatures
protected static char[]	DEFAULT_LF
static String	FORMAT_NAME_CSV Name used to identify CSV format.

Fields inherited from class com.fasterxml.jackson.core.JsonFactory

_characterEscapes, _factoryFeatures, _generatorFeatures, _inputDecorator, _objectCodec, _outputDecorator, _parserFeatures, _recyclerRef, _rootByteSymbols, _rootCharSymbols, _rootValueSeparator, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_GENERATOR_FEATURE_FLAGS, DEFAULT_PARSER_FEATURE_FLAGS, FORMAT_NAME_JSON

Constructor Summary

Constructors

Constructor and Description
CsvFactory() Default constructor used to create factory instances.
CsvFactory(com.fasterxml.jackson.core.ObjectCodec oc)

Method Summary

Methods

Modifier and Type	Method and Description
protected CsvGenerator	_createGenerator(com.fasterxml.jackson.core.io.IOContext ctxt, Writer out)
protected CsvGenerator	_createGenerator(Writer out, com.fasterxml.jackson.core.io.IOContext ctxt) Overridable factory method that actually instantiates desired generator.
protected CsvParser	_createParser(byte[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt) Overridable factory method that actually instantiates desired parser.
protected CsvParser	_createParser(InputStream in, com.fasterxml.jackson.core.io.IOContext ctxt) Overridable factory method that actually instantiates desired parser.
protected CsvParser	_createParser(Reader r, com.fasterxml.jackson.core.io.IOContext ctxt) Overridable factory method that actually instantiates desired parser.
protected Reader	_createReader(byte[] data, int offset, int len, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)
protected Reader	_createReader(InputStream in, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)
protected Writer	_createWriter(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)
boolean	canUseSchema(com.fasterxml.jackson.core.FormatSchema schema)
CsvFactory	configure(CsvGenerator.Feature f, boolean state) Method for enabling or disabling specified generator feature (check CsvGenerator.Feature for list of features)
CsvFactory	configure(CsvParser.Feature f, boolean state) Method for enabling or disabling specified parser feature (check CsvParser.Feature for list of features)
CsvGenerator	createGenerator(OutputStream out) This method assumes use of UTF-8 for encoding.
CsvGenerator	createGenerator(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc)
CsvGenerator	createGenerator(Writer out)
CsvGenerator	createJsonGenerator(OutputStream out) This method assumes use of UTF-8 for encoding.
CsvGenerator	createJsonGenerator(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc) note: co-variant return type
CsvGenerator	createJsonGenerator(Writer w)
CsvParser	createJsonParser(byte[] data)
CsvParser	createJsonParser(byte[] data, int offset, int len)
CsvParser	createJsonParser(File f)
CsvParser	createJsonParser(InputStream in)
com.fasterxml.jackson.core.JsonParser	createJsonParser(Reader r)
CsvParser	createJsonParser(URL url)
CsvParser	createParser(byte[] data)
CsvParser	createParser(byte[] data, int offset, int len)
CsvParser	createParser(File f)
CsvParser	createParser(InputStream in)
com.fasterxml.jackson.core.JsonParser	createParser(Reader r)
CsvParser	createParser(String doc)
CsvParser	createParser(URL url)
CsvFactory	disable(CsvGenerator.Feature f) Method for disabling specified generator feature (check CsvGenerator.Feature for list of features)
CsvFactory	disable(CsvParser.Feature f) Method for disabling specified parser features (check CsvParser.Feature for list of features)
CsvFactory	enable(CsvGenerator.Feature f) Method for enabling specified generator features (check CsvGenerator.Feature for list of features)
CsvFactory	enable(CsvParser.Feature f) Method for enabling specified parser feature (check CsvParser.Feature for list of features)
String	getFormatName()
com.fasterxml.jackson.core.format.MatchStrength	hasFormat(com.fasterxml.jackson.core.format.InputAccessor acc) Sub-classes need to override this method (as of 1.8)
boolean	isEnabled(CsvGenerator.Feature f) Check whether specified generator feature is enabled.
boolean	isEnabled(CsvParser.Feature f) Checked whether specified parser feature is enabled.
com.fasterxml.jackson.core.Version	version()

Methods inherited from class com.fasterxml.jackson.core.JsonFactory

_checkInvalidCopy, _createContext, _createJsonGenerator, _createJsonParser, _createJsonParser, _createJsonParser, _createUTF8Generator, _createUTF8JsonGenerator, _getBufferRecycler, _optimizedStreamFromURL, configure, configure, configure, copy, createGenerator, createJsonGenerator, createJsonParser, disable, disable, disable, enable, enable, enable, getCharacterEscapes, getCodec, getInputDecorator, getOutputDecorator, getRootValueSeparator, hasJSONFormat, isEnabled, isEnabled, isEnabled, readResolve, requiresCustomCodec, setCharacterEscapes, setCodec, setInputDecorator, setOutputDecorator, setRootValueSeparator

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_NAME_CSV

public static final String FORMAT_NAME_CSV

Name used to identify CSV format. (and returned by getFormatName()

See Also:

Constant Field Values

DEFAULT_LF

protected static final char[] DEFAULT_LF

_csvParserFeatures

protected int _csvParserFeatures

_csvGeneratorFeatures

protected int _csvGeneratorFeatures

_cfgColumnSeparator

protected char _cfgColumnSeparator

_cfgQuoteCharacter

protected char _cfgQuoteCharacter

_cfgLineSeparator

protected char[] _cfgLineSeparator

Constructor Detail

CsvFactory

public CsvFactory()

Default constructor used to create factory instances. Creation of a factory instance is a light-weight operation, but it is still a good idea to reuse limited number of factory instances (and quite often just a single instance): factories are used as context for storing some reused processing objects (such as symbol tables parsers use) and this reuse only works within context of a single factory instance.

CsvFactory

public CsvFactory(com.fasterxml.jackson.core.ObjectCodec oc)

Method Detail

version

public com.fasterxml.jackson.core.Version version()

Specified by:

version in interface com.fasterxml.jackson.core.Versioned

Overrides:

version in class com.fasterxml.jackson.core.JsonFactory

getFormatName

public String getFormatName()

Overrides:

getFormatName in class com.fasterxml.jackson.core.JsonFactory

hasFormat

public com.fasterxml.jackson.core.format.MatchStrength hasFormat(com.fasterxml.jackson.core.format.InputAccessor acc)
                                                          throws IOException

Sub-classes need to override this method (as of 1.8)

Overrides:

hasFormat in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

canUseSchema

public boolean canUseSchema(com.fasterxml.jackson.core.FormatSchema schema)

Overrides:

canUseSchema in class com.fasterxml.jackson.core.JsonFactory

configure

public final CsvFactory configure(CsvParser.Feature f,
                   boolean state)

Method for enabling or disabling specified parser feature (check CsvParser.Feature for list of features)

enable

public CsvFactory enable(CsvParser.Feature f)

Method for enabling specified parser feature (check CsvParser.Feature for list of features)

disable

public CsvFactory disable(CsvParser.Feature f)

Method for disabling specified parser features (check CsvParser.Feature for list of features)

isEnabled

public final boolean isEnabled(CsvParser.Feature f)

Checked whether specified parser feature is enabled.

configure

public final CsvFactory configure(CsvGenerator.Feature f,
                   boolean state)

Method for enabling or disabling specified generator feature (check CsvGenerator.Feature for list of features)

enable

public CsvFactory enable(CsvGenerator.Feature f)

Method for enabling specified generator features (check CsvGenerator.Feature for list of features)

disable

public CsvFactory disable(CsvGenerator.Feature f)

Method for disabling specified generator feature (check CsvGenerator.Feature for list of features)

isEnabled

public final boolean isEnabled(CsvGenerator.Feature f)

Check whether specified generator feature is enabled.

createParser

public CsvParser createParser(File f)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public CsvParser createParser(URL url)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public CsvParser createParser(InputStream in)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public com.fasterxml.jackson.core.JsonParser createParser(Reader r)
                                                   throws IOException,
                                                          com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public CsvParser createParser(String doc)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public CsvParser createParser(byte[] data)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public CsvParser createParser(byte[] data,
                     int offset,
                     int len)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

public CsvParser createJsonParser(File f)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

public CsvParser createJsonParser(URL url)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

public CsvParser createJsonParser(InputStream in)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

public com.fasterxml.jackson.core.JsonParser createJsonParser(Reader r)
                                                       throws IOException,
                                                              com.fasterxml.jackson.core.JsonParseException

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

public CsvParser createJsonParser(byte[] data)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

public CsvParser createJsonParser(byte[] data,
                         int offset,
                         int len)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

createGenerator

public CsvGenerator createGenerator(OutputStream out,
                           com.fasterxml.jackson.core.JsonEncoding enc)
                             throws IOException

Overrides:

createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

createGenerator

public CsvGenerator createGenerator(OutputStream out)
                             throws IOException

This method assumes use of UTF-8 for encoding.

Overrides:

createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

createGenerator

public CsvGenerator createGenerator(Writer out)
                             throws IOException

Overrides:

createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

createJsonGenerator

public CsvGenerator createJsonGenerator(OutputStream out,
                               com.fasterxml.jackson.core.JsonEncoding enc)
                                 throws IOException

note: co-variant return type

Overrides:

createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

createJsonGenerator

public CsvGenerator createJsonGenerator(OutputStream out)
                                 throws IOException

This method assumes use of UTF-8 for encoding.

Overrides:

createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

createJsonGenerator

public CsvGenerator createJsonGenerator(Writer w)
                                 throws IOException

Overrides:

createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

_createParser

protected CsvParser _createParser(InputStream in,
                      com.fasterxml.jackson.core.io.IOContext ctxt)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overridable factory method that actually instantiates desired parser.

Overrides:

_createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

_createParser

protected CsvParser _createParser(Reader r,
                      com.fasterxml.jackson.core.io.IOContext ctxt)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overridable factory method that actually instantiates desired parser.

Overrides:

_createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

_createParser

protected CsvParser _createParser(byte[] data,
                      int offset,
                      int len,
                      com.fasterxml.jackson.core.io.IOContext ctxt)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonParseException

Overridable factory method that actually instantiates desired parser.

Overrides:

_createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

com.fasterxml.jackson.core.JsonParseException

_createGenerator

protected CsvGenerator _createGenerator(Writer out,
                            com.fasterxml.jackson.core.io.IOContext ctxt)
                                 throws IOException

Overridable factory method that actually instantiates desired generator.

Overrides:

_createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

_createWriter

protected Writer _createWriter(OutputStream out,
                   com.fasterxml.jackson.core.JsonEncoding enc,
                   com.fasterxml.jackson.core.io.IOContext ctxt)
                        throws IOException

Overrides:

_createWriter in class com.fasterxml.jackson.core.JsonFactory

Throws:

IOException

_createGenerator

protected CsvGenerator _createGenerator(com.fasterxml.jackson.core.io.IOContext ctxt,
                            Writer out)
                                 throws IOException

Throws:

IOException

_createReader

protected Reader _createReader(InputStream in,
                   com.fasterxml.jackson.core.JsonEncoding enc,
                   com.fasterxml.jackson.core.io.IOContext ctxt)
                        throws IOException

Throws:

IOException

_createReader

protected Reader _createReader(byte[] data,
                   int offset,
                   int len,
                   com.fasterxml.jackson.core.JsonEncoding enc,
                   com.fasterxml.jackson.core.io.IOContext ctxt)
                        throws IOException

Throws:

IOException