Class CsvFactory

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.Versioned, java.io.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 Description
      protected int _csvGeneratorFeatures  
      protected int _csvParserFeatures  
      protected CsvSchema _schema  
      (package private) static int DEFAULT_CSV_GENERATOR_FEATURE_FLAGS
      Bitfield (set of flags) of all generator features that are enabled by default.
      (package private) static int DEFAULT_CSV_PARSER_FEATURE_FLAGS
      Bitfield (set of flags) of all parser features that are enabled by default.
      protected static char[] DEFAULT_LF  
      protected static CsvSchema DEFAULT_SCHEMA  
      static java.lang.String FORMAT_NAME_CSV
      Name used to identify CSV format.
      private static long serialVersionUID  
      • Fields inherited from class com.fasterxml.jackson.core.JsonFactory

        _byteSymbolCanonicalizer, _characterEscapes, _factoryFeatures, _generatorFeatures, _inputDecorator, _maximumNonEscapedChar, _objectCodec, _outputDecorator, _parserFeatures, _quoteChar, _rootCharSymbols, _rootValueSeparator, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_GENERATOR_FEATURE_FLAGS, DEFAULT_PARSER_FEATURE_FLAGS, DEFAULT_QUOTE_CHAR, DEFAULT_ROOT_VALUE_SEPARATOR, FORMAT_NAME_JSON
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        CsvFactory()
      Default constructor used to create factory instances.
        CsvFactory​(com.fasterxml.jackson.core.ObjectCodec oc)  
      protected CsvFactory​(CsvFactory src, com.fasterxml.jackson.core.ObjectCodec oc)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected com.fasterxml.jackson.core.io.IOContext _createContext​(java.lang.Object srcRef, boolean resourceManaged)  
      protected CsvGenerator _createGenerator​(com.fasterxml.jackson.core.io.IOContext ctxt, java.io.Writer out)  
      protected CsvGenerator _createGenerator​(java.io.Writer out, com.fasterxml.jackson.core.io.IOContext ctxt)  
      protected CsvParser _createParser​(byte[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt)  
      protected CsvParser _createParser​(char[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt, boolean recyclable)  
      protected CsvParser _createParser​(java.io.InputStream in, com.fasterxml.jackson.core.io.IOContext ctxt)
      Overridable factory method that actually instantiates desired parser.
      protected CsvParser _createParser​(java.io.Reader r, com.fasterxml.jackson.core.io.IOContext ctxt)
      Overridable factory method that actually instantiates desired parser.
      protected java.io.Reader _createReader​(byte[] data, int offset, int len, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)  
      protected java.io.Reader _createReader​(java.io.InputStream in, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)  
      protected CsvGenerator _createUTF8Generator​(java.io.OutputStream out, com.fasterxml.jackson.core.io.IOContext ctxt)  
      protected java.io.Writer _createWriter​(java.io.OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)  
      boolean canUseCharArrays()  
      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)
      CsvFactory copy()  
      CsvGenerator createGenerator​(java.io.File f, com.fasterxml.jackson.core.JsonEncoding enc)  
      CsvGenerator createGenerator​(java.io.OutputStream out)
      This method assumes use of UTF-8 for encoding.
      CsvGenerator createGenerator​(java.io.OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc)  
      CsvGenerator createGenerator​(java.io.Writer out)  
      CsvParser createParser​(byte[] data)  
      CsvParser createParser​(byte[] data, int offset, int len)  
      CsvParser createParser​(char[] data)  
      CsvParser createParser​(char[] data, int offset, int len)  
      CsvParser createParser​(java.io.File f)  
      CsvParser createParser​(java.io.InputStream in)  
      CsvParser createParser​(java.io.Reader r)  
      CsvParser createParser​(java.lang.String doc)  
      CsvParser createParser​(java.net.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)
      java.lang.String getFormatName()  
      com.fasterxml.jackson.core.format.MatchStrength hasFormat​(com.fasterxml.jackson.core.format.InputAccessor acc)  
      boolean isEnabled​(CsvGenerator.Feature f)
      Check whether specified generator feature is enabled.
      boolean isEnabled​(CsvParser.Feature f)
      Checked whether specified parser feature is enabled.
      protected java.lang.Object readResolve()
      Method that we need to override to actually make restoration go through constructors etc.
      boolean requiresPropertyOrdering()  
      com.fasterxml.jackson.core.Version version()  
      • Methods inherited from class com.fasterxml.jackson.core.JsonFactory

        _checkInvalidCopy, _createNonBlockingContext, _createParser, _decorate, _decorate, _decorate, _decorate, _decorate, _getBufferRecycler, builder, canHandleBinaryNatively, canParseAsync, configure, configure, configure, createGenerator, createGenerator, createJsonGenerator, createJsonGenerator, createJsonGenerator, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createNonBlockingByteArrayParser, createParser, disable, disable, disable, enable, enable, enable, getCharacterEscapes, getCodec, getFormatGeneratorFeatures, getFormatParserFeatures, getFormatReadFeatureType, getFormatWriteFeatureType, getGeneratorFeatures, getInputDecorator, getOutputDecorator, getParserFeatures, getRootValueSeparator, hasJSONFormat, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, rebuild, requiresCustomCodec, setCharacterEscapes, setCodec, setInputDecorator, setOutputDecorator, setRootValueSeparator
      • Methods inherited from class com.fasterxml.jackson.core.TokenStreamFactory

        _createDataOutputWrapper, _optimizedStreamFromURL
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEFAULT_CSV_PARSER_FEATURE_FLAGS

        static final int DEFAULT_CSV_PARSER_FEATURE_FLAGS
        Bitfield (set of flags) of all parser features that are enabled by default.
      • DEFAULT_CSV_GENERATOR_FEATURE_FLAGS

        static final int DEFAULT_CSV_GENERATOR_FEATURE_FLAGS
        Bitfield (set of flags) of all generator features that are enabled by default.
      • DEFAULT_LF

        protected static final char[] DEFAULT_LF
      • DEFAULT_SCHEMA

        protected static final CsvSchema DEFAULT_SCHEMA
      • _csvParserFeatures

        protected int _csvParserFeatures
      • _csvGeneratorFeatures

        protected int _csvGeneratorFeatures
    • 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)
      • CsvFactory

        protected CsvFactory​(CsvFactory src,
                             com.fasterxml.jackson.core.ObjectCodec oc)
        Since:
        2.2.1
    • Method Detail

      • copy

        public CsvFactory copy()
        Overrides:
        copy in class com.fasterxml.jackson.core.JsonFactory
      • readResolve

        protected java.lang.Object readResolve()
        Method that we need to override to actually make restoration go through constructors etc. Also: must be overridden by sub-classes as well.
        Overrides:
        readResolve in class com.fasterxml.jackson.core.JsonFactory
      • 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
      • requiresPropertyOrdering

        public boolean requiresPropertyOrdering()
        Overrides:
        requiresPropertyOrdering in class com.fasterxml.jackson.core.JsonFactory
      • canUseCharArrays

        public boolean canUseCharArrays()
        Overrides:
        canUseCharArrays in class com.fasterxml.jackson.core.JsonFactory
      • getFormatName

        public java.lang.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 java.io.IOException
        Overrides:
        hasFormat in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • canUseSchema

        public boolean canUseSchema​(com.fasterxml.jackson.core.FormatSchema schema)
        Overrides:
        canUseSchema in class com.fasterxml.jackson.core.JsonFactory
      • isEnabled

        public final boolean isEnabled​(CsvParser.Feature f)
        Checked whether specified parser feature is enabled.
      • isEnabled

        public final boolean isEnabled​(CsvGenerator.Feature f)
        Check whether specified generator feature is enabled.
      • createParser

        public CsvParser createParser​(java.io.File f)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(java.net.URL url)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(java.io.InputStream in)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(java.io.Reader r)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(java.lang.String doc)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(byte[] data)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(byte[] data,
                                      int offset,
                                      int len)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(char[] data)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createParser

        public CsvParser createParser​(char[] data,
                                      int offset,
                                      int len)
                               throws java.io.IOException
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createGenerator

        public CsvGenerator createGenerator​(java.io.OutputStream out,
                                            com.fasterxml.jackson.core.JsonEncoding enc)
                                     throws java.io.IOException
        Overrides:
        createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createGenerator

        public CsvGenerator createGenerator​(java.io.OutputStream out)
                                     throws java.io.IOException
        This method assumes use of UTF-8 for encoding.
        Overrides:
        createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createGenerator

        public CsvGenerator createGenerator​(java.io.Writer out)
                                     throws java.io.IOException
        Overrides:
        createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • createGenerator

        public CsvGenerator createGenerator​(java.io.File f,
                                            com.fasterxml.jackson.core.JsonEncoding enc)
                                     throws java.io.IOException
        Overrides:
        createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createParser

        protected CsvParser _createParser​(java.io.InputStream in,
                                          com.fasterxml.jackson.core.io.IOContext ctxt)
                                   throws java.io.IOException
        Overridable factory method that actually instantiates desired parser.
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createParser

        protected CsvParser _createParser​(byte[] data,
                                          int offset,
                                          int len,
                                          com.fasterxml.jackson.core.io.IOContext ctxt)
                                   throws java.io.IOException
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createParser

        protected CsvParser _createParser​(java.io.Reader r,
                                          com.fasterxml.jackson.core.io.IOContext ctxt)
                                   throws java.io.IOException
        Overridable factory method that actually instantiates desired parser.
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createParser

        protected CsvParser _createParser​(char[] data,
                                          int offset,
                                          int len,
                                          com.fasterxml.jackson.core.io.IOContext ctxt,
                                          boolean recyclable)
                                   throws java.io.IOException
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createGenerator

        protected CsvGenerator _createGenerator​(java.io.Writer out,
                                                com.fasterxml.jackson.core.io.IOContext ctxt)
                                         throws java.io.IOException
        Overrides:
        _createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createUTF8Generator

        protected CsvGenerator _createUTF8Generator​(java.io.OutputStream out,
                                                    com.fasterxml.jackson.core.io.IOContext ctxt)
                                             throws java.io.IOException
        Overrides:
        _createUTF8Generator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createWriter

        protected java.io.Writer _createWriter​(java.io.OutputStream out,
                                               com.fasterxml.jackson.core.JsonEncoding enc,
                                               com.fasterxml.jackson.core.io.IOContext ctxt)
                                        throws java.io.IOException
        Overrides:
        _createWriter in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        java.io.IOException
      • _createGenerator

        protected CsvGenerator _createGenerator​(com.fasterxml.jackson.core.io.IOContext ctxt,
                                                java.io.Writer out)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • _createReader

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

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

        protected com.fasterxml.jackson.core.io.IOContext _createContext​(java.lang.Object srcRef,
                                                                         boolean resourceManaged)
        Overrides:
        _createContext in class com.fasterxml.jackson.core.JsonFactory