Reduced the constants in CSVFormat for disabling the features to only one

git-svn-id: https://svn.apache.org/repos/asf/commons/sandbox/csv/trunk@1200061 13f79535-47bb-0310-9956-ffa450edef68

Author: ebourg

src/main/java/org/apache/commons/csv/CSVFormat.java

@@ -28,30 +28,31 @@ public class CSVFormat implements Cloneable, Serializable {
 
     private char delimiter = ',';
     private char encapsulator = '"';
-    private char commentStart = COMMENTS_DISABLED;
-    private char escape = ESCAPE_DISABLED;
+    private char commentStart = DISABLED;
+    private char escape = DISABLED;
     private boolean leadingSpacesIgnored = true;
     private boolean trailingSpacesIgnored = true;
     private boolean unicodeEscapesInterpreted = false;
     private boolean emptyLinesIgnored = true;
     private String lineSeparator = "\n";
 
-    // -2 is used to signal disabled, because it won't be confused with
-    // an EOF signal (-1), and because \ufffe in UTF-16 would be
-    // encoded as two chars (using surrogates) and thus there should never
-    // be a collision with a real text char.
-    public static final char COMMENTS_DISABLED = (char) -2;
-    public static final char ESCAPE_DISABLED = (char) -2;
-    public static final char ENCAPSULATOR_DISABLED = (char) -2;
+
+    /**
+     * Constant char to be used for disabling comments, escapes and encapsulation.
+     * The value -2 is used because it won't be confused with an EOF signal (-1),
+     * and because the unicode value FFFE would be encoded as two chars (using surrogates)
+     * and thus there should never be a collision with a real text char.
+     */
+    public static final char DISABLED = '\ufffe';
 
     /** Standard comma separated format. */
-    public static final CSVFormat DEFAULT = new CSVFormat(',', '"', COMMENTS_DISABLED, ESCAPE_DISABLED, true, true, false, true);
-    
+    public static final CSVFormat DEFAULT = new CSVFormat(',', '"', DISABLED, DISABLED, true, true, false, true);
+
     /** Excel file format (using a comma as the value delimiter). */
-    public static final CSVFormat EXCEL = new CSVFormat(',', '"', COMMENTS_DISABLED, ESCAPE_DISABLED, false, false, false, false);
-    
+    public static final CSVFormat EXCEL = new CSVFormat(',', '"', DISABLED, DISABLED, false, false, false, false);
+
     /** Tabulation delimited format. */
-    public static final CSVFormat TDF = new CSVFormat('\t', '"', COMMENTS_DISABLED, ESCAPE_DISABLED, true, true, false, true);
+    public static final CSVFormat TDF = new CSVFormat('\t', '"', DISABLED, DISABLED, true, true, false, true);
 
 
     /**
@@ -61,7 +62,7 @@ public CSVFormat() {
     }
 
     public CSVFormat(char delimiter, char encapsulator, char commentStart) {
-        this(delimiter, encapsulator, commentStart, ESCAPE_DISABLED, true, true, false, true);
+        this(delimiter, encapsulator, commentStart, DISABLED, true, true, false, true);
     }
 
     /**
@@ -115,6 +116,10 @@ public CSVFormat withEncapsulator(char encapsulator) {
         return format;
     }
 
+    boolean isEncapsulating() {
+        return this.encapsulator != DISABLED;
+    }
+
     public char getCommentStart() {
         return commentStart;
     }
@@ -126,7 +131,7 @@ public CSVFormat withCommentStart(char commentStart) {
     }
 
     public boolean isCommentingDisabled() {
-        return this.commentStart == COMMENTS_DISABLED;
+        return this.commentStart == DISABLED;
     }
 
     public char getEscape() {
@@ -139,6 +144,10 @@ public CSVFormat withEscape(char escape) {
         return format;
     }
 
+    boolean isEscaping() {
+        return this.escape != DISABLED;
+    }
+
     public boolean isLeadingSpacesIgnored() {
         return leadingSpacesIgnored;
     }

src/main/java/org/apache/commons/csv/CSVPrinter.java

@@ -127,10 +127,10 @@ public void print(char[] value, int offset, int len, boolean checkForEscape) thr
             out.write(value, offset, len);
             return;
         }
-
-        if (format.getEncapsulator() != CSVFormat.ENCAPSULATOR_DISABLED) {
+        
+        if (format.isEncapsulating()) {
             printAndEncapsulate(value, offset, len);
-        } else if (format.getEscape() != CSVFormat.ESCAPE_DISABLED) {
+        } else if (format.isEscaping()) {
             printAndEscape(value, offset, len);
         } else {
             printSep();

src/test/java/org/apache/commons/csv/CSVParserTest.java

@@ -438,7 +438,7 @@ public void testBackslashEscaping() throws IOException {
         };
 
 
-        CSVFormat format = new CSVFormat(',', '\'', CSVFormat.COMMENTS_DISABLED, '/', false, false, true, true);
+        CSVFormat format = new CSVFormat(',', '\'', CSVFormat.DISABLED, '/', false, false, true, true);
 
         CSVParser parser = new CSVParser(new StringReader(code), format);
         String[][] tmp = parser.getRecords();
@@ -466,7 +466,7 @@ public void testBackslashEscaping2() throws IOException {
         };
 
 
-        CSVFormat format = new CSVFormat(',', CSVFormat.ENCAPSULATOR_DISABLED, CSVFormat.COMMENTS_DISABLED, '/', false, false, true, true);
+        CSVFormat format = new CSVFormat(',',  CSVFormat.DISABLED,  CSVFormat.DISABLED, '/', false, false, true, true);
 
         CSVParser parser = new CSVParser(new StringReader(code), format);
         String[][] tmp = parser.getRecords();
@@ -493,7 +493,7 @@ public void testDefaultFormat() throws IOException {
         };
 
         CSVFormat format = CSVFormat.DEFAULT;
-        assertEquals(CSVFormat.COMMENTS_DISABLED, format.getCommentStart());
+        assertEquals(CSVFormat.DISABLED, format.getCommentStart());
 
         CSVParser parser = new CSVParser(new StringReader(code), format);
         String[][] tmp = parser.getRecords();

src/test/java/org/apache/commons/csv/CSVPrinterTest.java

@@ -111,7 +111,7 @@ public void testRandom() throws Exception {
         doRandom(iter);
 
         // Format for MySQL
-        format = new CSVFormat('\t', CSVFormat.ENCAPSULATOR_DISABLED, CSVFormat.COMMENTS_DISABLED, '\\', false, false, false, false);
+        format = new CSVFormat('\t',  CSVFormat.DISABLED,  CSVFormat.DISABLED, '\\', false, false, false, false);
         doRandom(iter);
     }