## Uses of Class
com.fasterxml.jackson.dataformat.csv.CsvSchema

- Packages that use CsvSchema
  Package | Description
  --- | ---
  com.fasterxml.jackson.dataformat.csv |
  com.fasterxml.jackson.dataformat.csv.impl |

- - ### Uses of CsvSchema in com.fasterxml.jackson.dataformat.csv

    Fields in com.fasterxml.jackson.dataformat.csv declared as CsvSchema
    Modifier and Type | Field and Description
    --- | ---
    `protected CsvSchema` | CsvParser.`_schema` Definition of columns being read.
    `protected CsvSchema` | CsvMappingException.`_schema`
    `protected CsvSchema` | CsvGenerator.`_schema` Definition of columns being written, if available.
    `protected CsvSchema` | CsvFactory.`_schema`
    `protected static CsvSchema` | CsvFactory.`DEFAULT_SCHEMA`

    Fields in com.fasterxml.jackson.dataformat.csv with type parameters of type CsvSchema
    Modifier and Type | Field and Description
    --- | ---
    `protected LRUMap<com.fasterxml.jackson.databind.JavaType,CsvSchema>` | CsvMapper.`_typedSchemas` Simple caching for schema instances, given that they are relatively expensive to construct; this one is for typed schemas
    `protected LRUMap<com.fasterxml.jackson.databind.JavaType,CsvSchema>` | CsvMapper.`_untypedSchemas` Simple caching for schema instances, given that they are relatively expensive to construct; this one is for "loose" (non-typed) schemas

    Methods in com.fasterxml.jackson.dataformat.csv that return CsvSchema
    Modifier and Type | Method and Description
    --- | ---
    `protected CsvSchema` | CsvMapper.`_schemaFor(com.fasterxml.jackson.databind.JavaType pojoType, LRUMap<com.fasterxml.jackson.databind.JavaType,CsvSchema> schemas, boolean typed)`
    `protected CsvSchema` | CsvSchema.`_withFeature(int feature, boolean state)`
    `CsvSchema` | CsvSchema.Builder.`build()`
    `static CsvSchema` | CsvSchema.`emptySchema()` Accessor for creating a "default" CSV schema instance, with following settings: Does NOT use header line Uses double quotes ('"') for quoting of field values (if necessary) Uses comma (',') as the field separator Uses Unix linefeed ('\n') as row separator Does NOT use any escape characters Does NOT have any columns defined
    `CsvSchema` | CsvParser.`getSchema()` Accessor for getting active schema definition: it may be "empty" (no column definitions), but will never be null since it defaults to an empty schema (and default configuration)
    `CsvSchema` | CsvMappingException.`getSchema()`
    `CsvSchema` | CsvMapper.`schema()` Convenience method that is same as
    `CsvSchema` | CsvMapper.`schemaFor(Class<?> pojoType)`
    `CsvSchema` | CsvMapper.`schemaFor(com.fasterxml.jackson.databind.JavaType pojoType)` Method that can be used to determine a CSV schema to use for given POJO type, using default serialization settings including ordering.
    `CsvSchema` | CsvMapper.`schemaFor(com.fasterxml.jackson.core.type.TypeReference<?> pojoTypeRef)`
    `CsvSchema` | CsvMapper.`schemaWithHeader()` Convenience method that is same as
    `CsvSchema` | CsvSchema.`sortedBy(Comparator<String> cmp)` Mutant factory method that will construct a new instance in which columns are sorted using given `Comparator` over column names.
    `CsvSchema` | CsvSchema.`sortedBy(String... columnNames)` Mutant factory method that will construct a new instance in which columns are sorted based on names given as argument.
    `CsvSchema` | CsvMapper.`typedSchemaFor(Class<?> pojoType)`
    `CsvSchema` | CsvMapper.`typedSchemaFor(com.fasterxml.jackson.databind.JavaType pojoType)` Method that can be used to determine a CSV schema to use for given POJO type, using default serialization settings including ordering.
    `CsvSchema` | CsvMapper.`typedSchemaFor(com.fasterxml.jackson.core.type.TypeReference<?> pojoTypeRef)`
    `CsvSchema` | CsvSchema.`withAllowComments(boolean state)` Method to indicate whether "hash comments" are allowed for document described by this schema.
    `CsvSchema` | CsvSchema.`withAnyPropertyName(String name)`
    `CsvSchema` | CsvSchema.`withArrayElementSeparator(char c)` Deprecated. use `withArrayElementSeparator(String)` instead
    `CsvSchema` | CsvSchema.`withArrayElementSeparator(String separator)`
    `CsvSchema` | CsvSchema.`withColumnReordering(boolean state)` Returns a clone of this instance by changing or setting the column reordering flag
    `CsvSchema` | CsvSchema.`withColumnSeparator(char sep)`
    `CsvSchema` | CsvSchema.`withColumnsFrom(CsvSchema toAppend)` Mutant factory method that will try to combine columns of this schema with those from `toAppend`, starting with columns of this instance, and ignoring duplicates (if any) from argument `toAppend`.
    `CsvSchema` | CsvSchema.`withComments()` Method to indicate that "hash comments" ARE allowed for document described by this schema.
    `CsvSchema` | CsvSchema.`withEscapeChar(char c)`
    `CsvSchema` | CsvSchema.`withHeader()` Helper method for constructing and returning schema instance that is similar to this one, except that it will be using header line.
    `CsvSchema` | CsvSchema.`withLineSeparator(String sep)`
    `CsvSchema` | CsvSchema.`withNullValue(String nvl)`
    `CsvSchema` | CsvSchema.`withoutArrayElementSeparator()`
    `CsvSchema` | CsvSchema.`withoutColumns()`
    `CsvSchema` | CsvSchema.`withoutComments()` Method to indicate that "hash comments" are NOT allowed for document described by this schema.
    `CsvSchema` | CsvSchema.`withoutEscapeChar()`
    `CsvSchema` | CsvSchema.`withoutHeader()` Helper method for construcing and returning schema instance that is similar to this one, except that it will not be using header line.
    `CsvSchema` | CsvSchema.`withoutQuoteChar()`
    `CsvSchema` | CsvSchema.`withQuoteChar(char c)`
    `CsvSchema` | CsvSchema.`withSkipFirstDataRow(boolean state)`
    `CsvSchema` | CsvSchema.`withStrictHeaders(boolean state)` Returns a clone of this instance by changing or setting the strict headers flag
    `CsvSchema` | CsvSchema.`withUseHeader(boolean state)`

    Methods in com.fasterxml.jackson.dataformat.csv with parameters of type CsvSchema
    Modifier and Type | Method and Description
    --- | ---
    `CsvSchema.Builder` | CsvSchema.Builder.`addColumnsFrom(CsvSchema schema)` NOTE: unlike many other add methods, this method DOES check for, and discard, possible duplicate columns: that is, if this builder already has a column with same name as column to be added, existing column is retained and new column ignored.
    `static CsvMappingException` | CsvMappingException.`from(CsvParser p, String msg, CsvSchema schema)`
    `CsvSchema` | CsvSchema.`withColumnsFrom(CsvSchema toAppend)` Mutant factory method that will try to combine columns of this schema with those from `toAppend`, starting with columns of this instance, and ignoring duplicates (if any) from argument `toAppend`.

    Method parameters in com.fasterxml.jackson.dataformat.csv with type arguments of type CsvSchema
    Modifier and Type | Method and Description
    --- | ---
    `protected CsvSchema` | CsvMapper.`_schemaFor(com.fasterxml.jackson.databind.JavaType pojoType, LRUMap<com.fasterxml.jackson.databind.JavaType,CsvSchema> schemas, boolean typed)`

    Constructors in com.fasterxml.jackson.dataformat.csv with parameters of type CsvSchema
    Constructor and Description
    `CsvGenerator(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int csvFeatures, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, CsvSchema schema)`
    `CsvMappingException(CsvParser p, String msg, CsvSchema schema)`
    `CsvSchema.Builder(CsvSchema src)` "Copy" constructor which creates builder that has settings of given source schema
    `CsvSchema(CsvSchema base, CsvSchema.Column[] columns)` Copy constructor used for creating variants using `sortedBy()` methods.
    `CsvSchema(CsvSchema base, int features)` Copy constructor used for creating variants for on/off features

  - ### Uses of CsvSchema in com.fasterxml.jackson.dataformat.csv.impl

    Methods in com.fasterxml.jackson.dataformat.csv.impl with parameters of type CsvSchema
    Modifier and Type | Method and Description
    --- | ---
    `void` | CsvDecoder.`setSchema(CsvSchema schema)`
    `CsvEncoder` | CsvEncoder.`withSchema(CsvSchema schema)`

    Constructors in com.fasterxml.jackson.dataformat.csv.impl with parameters of type CsvSchema
    Constructor and Description
    `CsvDecoder(CsvParser owner, com.fasterxml.jackson.core.io.IOContext ctxt, Reader r, CsvSchema schema, TextBuffer textBuffer, int stdFeatures, int csvFeatures)`
    `CsvEncoder(CsvEncoder base, CsvSchema newSchema)`
    `CsvEncoder(com.fasterxml.jackson.core.io.IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema)`

Copyright © 2017 FasterXML. All rights reserved.