1 /*
2 * Copyright 2007 Kasper B. Graversen
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.supercsv.quote;
17
18 import org.supercsv.prefs.CsvPreference;
19 import org.supercsv.util.CsvContext;
20
21 /**
22 * The interface for quoting modes. The quote mode allows quoting to be enabled in cases where quotes would not normally
23 * be required (because the column doesn't contain any special characters). It is not a way to disable quoting
24 * altogether - to do that you must supply your own CsvEncoder.
25 *
26 * @author James Bassett
27 * @since 2.1.0
28 */
29 public interface QuoteMode {
30
31 /**
32 * Determines whether surrounding quotes are mandatory in cases where the CSV column would not normally be quoted
33 * (the data to be written doesn't contain special characters).
34 *
35 * @param csvColumn
36 * an element of a CSV file
37 * @param context
38 * the context
39 * @param preference
40 * the CSV preferences
41 * @return true if surrounding quotes are mandatory, otherwise false
42 */
43 boolean quotesRequired(String csvColumn, CsvContext context, CsvPreference preference);
44
45 }