Class CsvFactory

java.lang.Object
tools.jackson.core.TokenStreamFactory
tools.jackson.core.base.DecorableTSFactory
tools.jackson.core.base.TextualTSFactory
tools.jackson.dataformat.csv.CsvFactory
All Implemented Interfaces:
Serializable, tools.jackson.core.util.Snapshottable<tools.jackson.core.TokenStreamFactory>, tools.jackson.core.Versioned
public class CsvFactory extends tools.jackson.core.base.TextualTSFactory implements Serializable
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class tools.jackson.core.base.DecorableTSFactory

    tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder<F,T>

    Nested classes/interfaces inherited from class tools.jackson.core.TokenStreamFactory

    tools.jackson.core.TokenStreamFactory.Feature

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final CsvCharacterEscapes
    _characterEscapes
     
    protected static final int
    DEFAULT_CSV_GENERATOR_FEATURE_FLAGS
    Bit field (set of flags) of all generator features that are enabled by default.
    protected static final int
    DEFAULT_CSV_PARSER_FEATURE_FLAGS
    Bit field (set of flags) of all parser features that are enabled by default.
    protected static final CsvSchema
    DEFAULT_SCHEMA
     
    static final String
    FORMAT_NAME_CSV
    Name used to identify CSV format.
    private static final long
    serialVersionUID
     

    Fields inherited from class tools.jackson.core.base.DecorableTSFactory

    _generatorDecorators, _inputDecorator, _outputDecorator

    Fields inherited from class tools.jackson.core.TokenStreamFactory

    _errorReportConfiguration, _factoryFeatures, _formatReadFeatures, _formatWriteFeatures, _recyclerPool, _streamReadConstraints, _streamReadFeatures, _streamWriteConstraints, _streamWriteFeatures, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_STREAM_READ_FEATURE_FLAGS, DEFAULT_STREAM_WRITE_FEATURE_FLAGS, EMPTY_WRITE_CONTEXT

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CsvFactory()
    Default constructor used to create factory instances.
    protected
    CsvFactory(CsvFactory src)
     
    protected
    CsvFactory(CsvFactoryBuilder b)
    Constructors used by CsvFactoryBuilder for instantiation.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected CsvGenerator
    _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, Writer out)
     
    protected CsvParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, byte[] data, int offset, int len)
     
    protected CsvParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)
     
    protected tools.jackson.core.JsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, DataInput input)
     
    protected CsvParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, InputStream in)
    Overridable factory method that actually instantiates desired parser.
    protected CsvParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, Reader r)
    Overridable factory method that actually instantiates desired parser.
    protected CsvGenerator
    _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, OutputStream out)
     
    private final CsvSchema
    _getSchema(tools.jackson.core.ObjectReadContext readCtxt)
     
    private final CsvSchema
    _getSchema(tools.jackson.core.ObjectWriteContext writeCtxt)
     
    static CsvFactoryBuilder
    builder()
    Main factory method to use for constructing CsvFactory instances with different configuration.
    boolean
    canParseAsync()
     
    boolean
    canUseCharArrays()
     
    boolean
    canUseSchema(tools.jackson.core.FormatSchema schema)
     
    CsvFactory
    copy()
     
    String
    getFormatName()
     
    int
    getFormatReadFeatures()
     
    Class<CsvReadFeature>
    getFormatReadFeatureType()
     
    int
    getFormatWriteFeatures()
     
    Class<CsvWriteFeature>
    getFormatWriteFeatureType()
     
    final boolean
    isEnabled(CsvReadFeature f)
    Checked whether specified parser feature is enabled.
    boolean
    isEnabled(CsvWriteFeature f)
    Check whether specified generator feature is enabled.
    protected Object
    readResolve()
    Method that we need to override to actually make restoration go through constructors etc.
    CsvFactoryBuilder
    rebuild()
     
    boolean
    requiresPropertyOrdering()
     
    tools.jackson.core.TokenStreamFactory
    snapshot()
    Instances are immutable so just return `this`
    tools.jackson.core.Version
    version()
     

    Methods inherited from class tools.jackson.core.base.TextualTSFactory

    _createContentReference, _createContentReference, _createWriter, canHandleBinaryNatively, createGenerator, createGenerator, createGenerator, createGenerator, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser

    Methods inherited from class tools.jackson.core.base.DecorableTSFactory

    _copy, _decorate, _decorate, _decorate, _decorate, _decorate, _decorate, getGeneratorDecorators, getInputDecorator, getOutputDecorator

    Methods inherited from class tools.jackson.core.TokenStreamFactory

    _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _createContext, _createContext, _createDataOutputWrapper, _fileInputStream, _fileOutputStream, _getBufferRecycler, _getRecyclerPool, _optimizedStreamFromURL, _pathInputStream, _pathOutputStream, _reportRangeError, _unsupported, _unsupported, _wrapIOFailure, constructCINameMatcher, constructNameMatcher, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createNonBlockingByteArrayParser, createNonBlockingByteBufferParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, errorReportConfiguration, getFactoryFeatures, getStreamReadFeatures, getStreamWriteFeatures, isEnabled, isEnabled, isEnabled, streamReadConstraints, streamWriteConstraints

    Methods inherited from class Object

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

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • FORMAT_NAME_CSV

      public static final String FORMAT_NAME_CSV
      Name used to identify CSV format. (and returned by getFormatName()
      See Also:

    • DEFAULT_CSV_PARSER_FEATURE_FLAGS

      protected static final int DEFAULT_CSV_PARSER_FEATURE_FLAGS
      Bit field (set of flags) of all parser features that are enabled by default.

    • DEFAULT_CSV_GENERATOR_FEATURE_FLAGS

      protected static final int DEFAULT_CSV_GENERATOR_FEATURE_FLAGS
      Bit field (set of flags) of all generator features that are enabled by default.

    • DEFAULT_SCHEMA

      protected static final CsvSchema DEFAULT_SCHEMA

    • _characterEscapes

      protected final CsvCharacterEscapes _characterEscapes

  • Constructor Details

    • 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

      protected CsvFactory(CsvFactory src)

    • CsvFactory

      protected CsvFactory(CsvFactoryBuilder b)
      Constructors used by CsvFactoryBuilder for instantiation.
      Since:
      3.0

  • Method Details

    • rebuild

      public CsvFactoryBuilder rebuild()
      Specified by:
      rebuild in class tools.jackson.core.TokenStreamFactory

    • builder

      public static CsvFactoryBuilder builder()
      Main factory method to use for constructing CsvFactory instances with different configuration.

    • copy

      public CsvFactory copy()
      Specified by:
      copy in class tools.jackson.core.TokenStreamFactory

    • snapshot

      public tools.jackson.core.TokenStreamFactory snapshot()
      Instances are immutable so just return `this`
      Specified by:
      snapshot in interface tools.jackson.core.util.Snapshottable<tools.jackson.core.TokenStreamFactory>
      Specified by:
      snapshot in class tools.jackson.core.TokenStreamFactory

    • readResolve

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

    • version

      public tools.jackson.core.Version version()
      Specified by:
      version in interface tools.jackson.core.Versioned
      Specified by:
      version in class tools.jackson.core.TokenStreamFactory

    • requiresPropertyOrdering

      public boolean requiresPropertyOrdering()
      Overrides:
      requiresPropertyOrdering in class tools.jackson.core.TokenStreamFactory

    • canUseCharArrays

      public boolean canUseCharArrays()
      Overrides:
      canUseCharArrays in class tools.jackson.core.base.TextualTSFactory

    • canParseAsync

      public boolean canParseAsync()
      Specified by:
      canParseAsync in class tools.jackson.core.TokenStreamFactory

    • getFormatName

      public String getFormatName()
      Specified by:
      getFormatName in class tools.jackson.core.TokenStreamFactory

    • canUseSchema

      public boolean canUseSchema(tools.jackson.core.FormatSchema schema)
      Specified by:
      canUseSchema in class tools.jackson.core.TokenStreamFactory

    • getFormatReadFeatureType

      public Class<CsvReadFeature> getFormatReadFeatureType()
      Overrides:
      getFormatReadFeatureType in class tools.jackson.core.TokenStreamFactory

    • getFormatWriteFeatureType

      public Class<CsvWriteFeature> getFormatWriteFeatureType()
      Overrides:
      getFormatWriteFeatureType in class tools.jackson.core.TokenStreamFactory

    • getFormatReadFeatures

      public int getFormatReadFeatures()
      Overrides:
      getFormatReadFeatures in class tools.jackson.core.TokenStreamFactory

    • getFormatWriteFeatures

      public int getFormatWriteFeatures()
      Overrides:
      getFormatWriteFeatures in class tools.jackson.core.TokenStreamFactory

    • isEnabled

      public final boolean isEnabled(CsvReadFeature f)
      Checked whether specified parser feature is enabled.

    • isEnabled

      public boolean isEnabled(CsvWriteFeature f)
      Check whether specified generator feature is enabled.

    • _createParser

      protected CsvParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, InputStream in)
      Overridable factory method that actually instantiates desired parser.
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected CsvParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, byte[] data, int offset, int len)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected CsvParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, Reader r)
      Overridable factory method that actually instantiates desired parser.
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected CsvParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected tools.jackson.core.JsonParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, DataInput input)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _getSchema

      private final CsvSchema _getSchema(tools.jackson.core.ObjectReadContext readCtxt)

    • _createGenerator

      protected CsvGenerator _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, Writer out)
      Specified by:
      _createGenerator in class tools.jackson.core.base.TextualTSFactory

    • _createUTF8Generator

      protected CsvGenerator _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, OutputStream out)
      Specified by:
      _createUTF8Generator in class tools.jackson.core.base.TextualTSFactory

    • _getSchema

      private final CsvSchema _getSchema(tools.jackson.core.ObjectWriteContext writeCtxt)