Internal refactoring for escape character

Author: garydgregory

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

@@ -1717,6 +1717,15 @@ public Character getEscapeCharacter() {
         return escapeCharacter;
     }
 
+    /**
+     * Gets the escape character.
+     *
+     * @return the escape character, may be {@code 0}
+     */
+    char getEscapeChar() {
+        return escapeCharacter != null ? escapeCharacter.charValue() : 0;
+    }
+
     /**
      * Gets a copy of the header array.
      *
@@ -2129,26 +2138,28 @@ public synchronized void printRecord(final Appendable appendable, final Object..
     }
 
     /*
-     * Note: Must only be called if escaping is enabled, otherwise will generate NPE.
+     * Note: Must only be called if escaping is enabled, otherwise can throw exceptions.
      */
     private void printWithEscapes(final CharSequence charSeq, final Appendable appendable) throws IOException {
         int start = 0;
         int pos = 0;
         final int end = charSeq.length();
         final char[] delim = getDelimiterCharArray();
         final int delimLength = delim.length;
-        final char escape = getEscapeCharacter().charValue();
+        final char escape = getEscapeChar();
         while (pos < end) {
             char c = charSeq.charAt(pos);
             final boolean isDelimiterStart = isDelimiter(c, charSeq, pos, delim, delimLength);
-            if (c == CR || c == LF || c == escape || isDelimiterStart) {
+            final boolean isCr = c == CR;
+            final boolean isLf = c == LF;
+            if (isCr || isLf || c == escape || isDelimiterStart) {
                 // write out segment up until this char
                 if (pos > start) {
                     appendable.append(charSeq, start, pos);
                 }
-                if (c == LF) {
+                if (isLf) {
                     c = 'n';
-                } else if (c == CR) {
+                } else if (isCr) {
                     c = 'r';
                 }
                 appendable.append(escape);
@@ -2172,30 +2183,35 @@ private void printWithEscapes(final CharSequence charSeq, final Appendable appen
         }
     }
 
+    /*
+     * Note: Must only be called if escaping is enabled, otherwise can throw exceptions.
+     */
     private void printWithEscapes(final Reader reader, final Appendable appendable) throws IOException {
         int start = 0;
         int pos = 0;
         @SuppressWarnings("resource") // Temp reader on input reader.
         final ExtendedBufferedReader bufferedReader = new ExtendedBufferedReader(reader);
         final char[] delim = getDelimiterCharArray();
         final int delimLength = delim.length;
-        final char escape = getEscapeCharacter().charValue();
+        final char escape = getEscapeChar();
         final StringBuilder builder = new StringBuilder(IOUtils.DEFAULT_BUFFER_SIZE);
         int c;
         while (EOF != (c = bufferedReader.read())) {
             builder.append((char) c);
             final boolean isDelimiterStart = isDelimiter((char) c, builder.toString() + new String(bufferedReader.lookAhead(delimLength - 1)), pos, delim,
                     delimLength);
-            if (c == CR || c == LF || c == escape || isDelimiterStart) {
+            final boolean isCr = c == CR;
+            final boolean isLf = c == LF;
+            if (isCr || isLf || c == escape || isDelimiterStart) {
                 // write out segment up until this char
                 if (pos > start) {
                     append(builder.substring(start, pos), appendable);
                     builder.setLength(0);
                     pos = -1;
                 }
-                if (c == LF) {
+                if (isLf) {
                     c = 'n';
-                } else if (c == CR) {
+                } else if (isCr) {
                     c = 'r';
                 }
                 append(escape, appendable);
@@ -2232,7 +2248,7 @@ private void printWithQuotes(final Object object, final CharSequence charSeq, fi
         // If escape char not specified, default to the quote char
         // This avoids having to keep checking whether there is an escape character
         // at the cost of checking against quote twice
-        final char escapeChar = isEscapeCharacterSet() ? getEscapeCharacter().charValue() : quoteChar;
+        final char escapeChar = isEscapeCharacterSet() ? getEscapeChar() : quoteChar;
         QuoteMode quoteModePolicy = getQuoteMode();
         if (quoteModePolicy == null) {
             quoteModePolicy = QuoteMode.MINIMAL;
@@ -2436,7 +2452,7 @@ private void validate() throws IllegalArgumentException {
             final boolean emptyDuplicatesAllowed = duplicateHeaderMode == DuplicateHeaderMode.ALLOW_EMPTY;
             for (final String header : headers) {
                 final boolean blank = isBlank(header);
-                // Sanitise all empty headers to the empty string "" when checking duplicates
+                // Sanitize all empty headers to the empty string "" when checking duplicates
                 final boolean containsHeader = !dupCheckSet.add(blank ? "" : header);
                 if (containsHeader && !(blank && emptyDuplicatesAllowed)) {
                     throw new IllegalArgumentException(

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

@@ -393,6 +393,7 @@ public void testEqualsOne() {
         final CSVFormat csvFormatTwo = CSVFormat.MYSQL;
 
         assertEquals('\\', (char) csvFormatOne.getEscapeCharacter());
+        assertEquals('\\', csvFormatOne.getEscapeChar());
         assertNull(csvFormatOne.getQuoteMode());
 
         assertTrue(csvFormatOne.getIgnoreEmptyLines());
@@ -426,6 +427,8 @@ public void testEqualsOne() {
         assertEquals(QuoteMode.ALL_NON_NULL, csvFormatTwo.getQuoteMode());
 
         assertEquals('\t', csvFormatTwo.getDelimiter());
+        assertArrayEquals(new char[] { '\t' }, csvFormatTwo.getDelimiterCharArray());
+        assertEquals("\t", csvFormatTwo.getDelimiterString());
         assertEquals("\n", csvFormatTwo.getRecordSeparator());
 
         assertFalse(csvFormatTwo.isQuoteCharacterSet());