org.supercsv.quote.QuoteMode Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of super-csv Show documentation

Super CSV is a fast, programmer-friendly, free CSV package for Java

The newest version!

/*
 * Copyright 2007 Kasper B. Graversen
 * 
 * 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 org.supercsv.quote;

import org.supercsv.prefs.CsvPreference;
import org.supercsv.util.CsvContext;

/**
 * The interface for quoting modes. The quote mode allows quoting to be enabled in cases where quotes would not normally
 * be required (because the column doesn't contain any special characters). It is not a way to disable quoting
 * altogether - to do that you must supply your own CsvEncoder.
 * 
 * @author James Bassett
 * @since 2.1.0
 */
public interface QuoteMode {
	
	/**
	 * Determines whether surrounding quotes are mandatory in cases where the CSV column would not normally be quoted
	 * (the data to be written doesn't contain special characters).
	 * 
	 * @param csvColumn
	 *            an element of a CSV file
	 * @param context
	 *            the context
	 * @param preference
	 *            the CSV preferences
	 * @return true if surrounding quotes are mandatory, otherwise false
	 */
	boolean quotesRequired(String csvColumn, CsvContext context, CsvPreference preference);
	
}