com.univocity.parsers.csv.UnescapedQuoteHandling Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of univocity-parsers Show documentation
univocity's open source parsers for processing different text formats using a consistent API
The newest version!
/*******************************************************************************
 * Copyright 2016 Univocity Software Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/

package com.univocity.parsers.csv;


import com.univocity.parsers.common.*;

/**
 * This enumeration is used to determine how the ({@link CsvParser}) will handle values with unescaped quotes.
 *
 * Use {@link CsvParserSettings#setUnescapedQuoteHandling(UnescapedQuoteHandling)} to configure the appropriate
 * handling of unescaped quotes on your input.
 *
 * @author Univocity Software Pty Ltd - [email protected]
 * @see com.univocity.parsers.csv.CsvParserSettings
 * @see com.univocity.parsers.csv.CsvFormat
 * @see com.univocity.parsers.csv.CsvParser
 * @see com.univocity.parsers.common.CommonParserSettings
 */
public enum UnescapedQuoteHandling {

	/**
	 * If unescaped quotes are found in the input, accumulate the quote character and proceed parsing the value
	 * as a quoted value, until a closing quote is found.
	 */
	STOP_AT_CLOSING_QUOTE,

	/**
	 * If unescaped quotes are found in the input, consider the value as an unquoted value. This will make the parser
	 * accumulate all characters of the current parsed value until the delimiter defined by {@link CsvFormat#getDelimiter()} is found.
	 * If no delimiter is found in the value, the parser will continue accumulating characters from the input
	 * until a delimiter or line ending is found.
	 */
	BACK_TO_DELIMITER,

	/**
	 * If unescaped quotes are found in the input, consider the value as an unquoted value. This will make the parser
	 * accumulate all characters until the delimiter defined by {@link CsvFormat#getDelimiter()}, or a line ending is found in the input.
	 */
	STOP_AT_DELIMITER,

	/**
	 * If unescaped quotes are found in the input, the content parsed for the given value will be skipped
	 * (until the next delimiter is found) and the value set in {@link CommonSettings#getNullValue()} will be produced instead.
	 */
	SKIP_VALUE,

	/**
	 * If unescaped quotes are found in the input, a {@link TextParsingException} will be thrown.
	 */
	RAISE_ERROR,
}