blob: a8524d0c631612b38cad609b5dea6316e320da97 [file] [log] [blame]
// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for univocity-parsers
== Spring Boot Auto-Configuration
When using univocity-parsers with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-univocity-parsers-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
----
The component supports 50 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.dataformat.univocity-csv.as-map* | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false | false | Boolean
| *camel.dataformat.univocity-csv.comment* | The comment symbol. The default value is # | # | String
| *camel.dataformat.univocity-csv.delimiter* | The delimiter of values | , | String
| *camel.dataformat.univocity-csv.empty-value* | The String representation of an empty value | | String
| *camel.dataformat.univocity-csv.enabled* | Whether to enable auto configuration of the univocity-csv data format. This is enabled by default. | | Boolean
| *camel.dataformat.univocity-csv.header-extraction-enabled* | Whether or not the header must be read in the first line of the test document The default value is false | false | Boolean
| *camel.dataformat.univocity-csv.headers-disabled* | Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false | false | Boolean
| *camel.dataformat.univocity-csv.ignore-leading-whitespaces* | Whether or not the leading white spaces must be ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-csv.ignore-trailing-whitespaces* | Whether or not the trailing white spaces must ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-csv.lazy-load* | Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false | false | Boolean
| *camel.dataformat.univocity-csv.line-separator* | The line separator of the files The default value is to use the JVM platform line separator | | String
| *camel.dataformat.univocity-csv.normalized-line-separator* | The normalized line separator of the files The default value is a new line character. | \n | String
| *camel.dataformat.univocity-csv.null-value* | The string representation of a null value. The default value is null | | String
| *camel.dataformat.univocity-csv.number-of-records-to-read* | The maximum number of record to read. | | Integer
| *camel.dataformat.univocity-csv.quote* | The quote symbol. | " | String
| *camel.dataformat.univocity-csv.quote-all-fields* | Whether or not all values must be quoted when writing them. | false | Boolean
| *camel.dataformat.univocity-csv.quote-escape* | The quote escape symbol | " | String
| *camel.dataformat.univocity-csv.skip-empty-lines* | Whether or not the empty lines must be ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-fixed.as-map* | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false | false | Boolean
| *camel.dataformat.univocity-fixed.comment* | The comment symbol. The default value is # | # | String
| *camel.dataformat.univocity-fixed.empty-value* | The String representation of an empty value | | String
| *camel.dataformat.univocity-fixed.enabled* | Whether to enable auto configuration of the univocity-fixed data format. This is enabled by default. | | Boolean
| *camel.dataformat.univocity-fixed.header-extraction-enabled* | Whether or not the header must be read in the first line of the test document The default value is false | false | Boolean
| *camel.dataformat.univocity-fixed.headers-disabled* | Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false | false | Boolean
| *camel.dataformat.univocity-fixed.ignore-leading-whitespaces* | Whether or not the leading white spaces must be ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-fixed.ignore-trailing-whitespaces* | Whether or not the trailing white spaces must ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-fixed.lazy-load* | Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false | false | Boolean
| *camel.dataformat.univocity-fixed.line-separator* | The line separator of the files The default value is to use the JVM platform line separator | | String
| *camel.dataformat.univocity-fixed.normalized-line-separator* | The normalized line separator of the files The default value is a new line character. | \n | String
| *camel.dataformat.univocity-fixed.null-value* | The string representation of a null value. The default value is null | | String
| *camel.dataformat.univocity-fixed.number-of-records-to-read* | The maximum number of record to read. | | Integer
| *camel.dataformat.univocity-fixed.padding* | The padding character. The default value is a space | | String
| *camel.dataformat.univocity-fixed.record-ends-on-newline* | Whether or not the record ends on new line. The default value is false | false | Boolean
| *camel.dataformat.univocity-fixed.skip-empty-lines* | Whether or not the empty lines must be ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-fixed.skip-trailing-chars-until-newline* | Whether or not the trailing characters until new line must be ignored. The default value is false | false | Boolean
| *camel.dataformat.univocity-tsv.as-map* | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false | false | Boolean
| *camel.dataformat.univocity-tsv.comment* | The comment symbol. The default value is # | # | String
| *camel.dataformat.univocity-tsv.empty-value* | The String representation of an empty value | | String
| *camel.dataformat.univocity-tsv.enabled* | Whether to enable auto configuration of the univocity-tsv data format. This is enabled by default. | | Boolean
| *camel.dataformat.univocity-tsv.escape-char* | The escape character. | \ | String
| *camel.dataformat.univocity-tsv.header-extraction-enabled* | Whether or not the header must be read in the first line of the test document The default value is false | false | Boolean
| *camel.dataformat.univocity-tsv.headers-disabled* | Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false | false | Boolean
| *camel.dataformat.univocity-tsv.ignore-leading-whitespaces* | Whether or not the leading white spaces must be ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-tsv.ignore-trailing-whitespaces* | Whether or not the trailing white spaces must ignored. The default value is true | true | Boolean
| *camel.dataformat.univocity-tsv.lazy-load* | Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false | false | Boolean
| *camel.dataformat.univocity-tsv.line-separator* | The line separator of the files The default value is to use the JVM platform line separator | | String
| *camel.dataformat.univocity-tsv.normalized-line-separator* | The normalized line separator of the files The default value is a new line character. | \n | String
| *camel.dataformat.univocity-tsv.null-value* | The string representation of a null value. The default value is null | | String
| *camel.dataformat.univocity-tsv.number-of-records-to-read* | The maximum number of record to read. | | Integer
| *camel.dataformat.univocity-tsv.skip-empty-lines* | Whether or not the empty lines must be ignored. The default value is true | true | Boolean
|===
// spring-boot-auto-configure options: END