View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   https://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.commons.csv;
20  
21  /**
22   * Defines quoting behavior.
23   *
24   * @see CSVFormat.Builder#setQuoteMode(QuoteMode)
25   */
26  public enum QuoteMode {
27  
28      /**
29       * Quotes all fields.
30       */
31      ALL,
32  
33      /**
34       * Quotes all non-null fields.
35       */
36      ALL_NON_NULL,
37  
38      /**
39       * Quotes fields that contain special characters such as a field delimiter, quote character, or any of the
40       * characters in the line separator string.
41       */
42      MINIMAL,
43  
44      /**
45       * Quotes all non-numeric fields.
46       */
47      NON_NUMERIC,
48  
49      /**
50       * Never quotes fields. When the delimiter occurs in data, the printer prefixes it with the escape character. If the
51       * escape character is not set, format validation throws an exception.
52       */
53      NONE
54  }