Restore commentMarker property which was overridden during refactoring

britter · britter · commit 67d150adc88b · 2014-07-21T19:42:40.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1612390 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -149,7 +149,7 @@ public final class CSVFormat implements Serializable {
     private final char delimiter;
     private final Character quoteCharacter; // null if quoting is disabled
     private final QuoteMode quoteMode;
-    private final Character commentStartCharacter; // null if commenting is disabled
+    private final Character commentMarker; // null if commenting is disabled
     private final Character escapeCharacter; // null if escaping is disabled
     private final boolean ignoreSurroundingSpaces; // Should leading/trailing spaces be ignored around values?
     private final boolean allowMissingColumnNames;
@@ -345,7 +345,7 @@ private CSVFormat(final char delimiter, final Character quoteChar,
         this.delimiter = delimiter;
         this.quoteCharacter = quoteChar;
         this.quoteMode = quoteMode;
-        this.commentStartCharacter = commentStart;
+        this.commentMarker = commentStart;
         this.escapeCharacter = escape;
         this.ignoreSurroundingSpaces = ignoreSurroundingSpaces;
         this.allowMissingColumnNames = allowMissingColumnNames;
@@ -394,11 +394,11 @@ public boolean equals(final Object obj) {
         } else if (!quoteCharacter.equals(other.quoteCharacter)) {
             return false;
         }
-        if (commentStartCharacter == null) {
-            if (other.commentStartCharacter != null) {
+        if (commentMarker == null) {
+            if (other.commentMarker != null) {
                 return false;
             }
-        } else if (!commentStartCharacter.equals(other.commentStartCharacter)) {
+        } else if (!commentMarker.equals(other.commentMarker)) {
             return false;
         }
         if (escapeCharacter == null) {
@@ -460,8 +460,8 @@ public String format(final Object... values) {
      *
      * @return the comment start marker, may be {@code null}
      */
-    public Character getCommentStartCharacter() {
-        return commentStartCharacter;
+    public Character getCommentMarker() {
+        return commentMarker;
     }
 
     /**
@@ -583,7 +583,7 @@ public int hashCode()
         result = prime * result + delimiter;
         result = prime * result + ((quoteMode == null) ? 0 : quoteMode.hashCode());
         result = prime * result + ((quoteCharacter == null) ? 0 : quoteCharacter.hashCode());
-        result = prime * result + ((commentStartCharacter == null) ? 0 : commentStartCharacter.hashCode());
+        result = prime * result + ((commentMarker == null) ? 0 : commentMarker.hashCode());
         result = prime * result + ((escapeCharacter == null) ? 0 : escapeCharacter.hashCode());
         result = prime * result + ((nullString == null) ? 0 : nullString.hashCode());
         result = prime * result + (ignoreSurroundingSpaces ? 1231 : 1237);
@@ -601,8 +601,8 @@ public int hashCode()
      *
      * @return {@code true} is comments are supported, {@code false} otherwise
      */
-    public boolean isCommentStartCharacterSet() {
-        return commentStartCharacter != null;
+    public boolean isCommentMarkerSet() {
+        return commentMarker != null;
     }
 
     /**
@@ -678,9 +678,9 @@ public String toString() {
             sb.append(' ');
             sb.append("QuoteChar=<").append(quoteCharacter).append('>');
         }
-        if (isCommentStartCharacterSet()) {
+        if (isCommentMarkerSet()) {
             sb.append(' ');
-            sb.append("CommentStart=<").append(commentStartCharacter).append('>');
+            sb.append("CommentStart=<").append(commentMarker).append('>');
         }
         if (isNullStringSet()) {
             sb.append(' ');
@@ -720,19 +720,19 @@ private void validate() throws IllegalArgumentException {
                     "The escape character and the delimiter cannot be the same ('" + escapeCharacter + "')");
         }
 
-        if (commentStartCharacter != null && delimiter == commentStartCharacter.charValue()) {
+        if (commentMarker != null && delimiter == commentMarker.charValue()) {
             throw new IllegalArgumentException(
-                    "The comment start character and the delimiter cannot be the same ('" + commentStartCharacter + "')");
+                    "The comment start character and the delimiter cannot be the same ('" + commentMarker + "')");
         }
 
-        if (quoteCharacter != null && quoteCharacter.equals(commentStartCharacter)) {
+        if (quoteCharacter != null && quoteCharacter.equals(commentMarker)) {
             throw new IllegalArgumentException(
-                    "The comment start character and the quoteChar cannot be the same ('" + commentStartCharacter + "')");
+                    "The comment start character and the quoteChar cannot be the same ('" + commentMarker + "')");
         }
 
-        if (escapeCharacter != null && escapeCharacter.equals(commentStartCharacter)) {
+        if (escapeCharacter != null && escapeCharacter.equals(commentMarker)) {
             throw new IllegalArgumentException(
-                    "The comment start and the escape character cannot be the same ('" + commentStartCharacter + "')");
+                    "The comment start and the escape character cannot be the same ('" + commentMarker + "')");
         }
 
         if (escapeCharacter == null && quoteMode == QuoteMode.NONE) {
@@ -788,7 +788,7 @@ public CSVFormat withDelimiter(final char delimiter) {
         if (isLineBreak(delimiter)) {
             throw new IllegalArgumentException("The delimiter cannot be a line break");
         }
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -819,7 +819,7 @@ public CSVFormat withEscape(final Character escape) {
         if (isLineBreak(escape)) {
             throw new IllegalArgumentException("The escape character cannot be a line break");
         }
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escape,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escape,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -842,7 +842,7 @@ public CSVFormat withEscape(final Character escape) {
      * @see #withSkipHeaderRecord(boolean)
      */
     public CSVFormat withHeader(final String... header) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -856,7 +856,7 @@ public CSVFormat withHeader(final String... header) {
      * @return A new CSVFormat that is equal to this but with the specified missing column names behavior.
      */
     public CSVFormat withAllowMissingColumnNames(final boolean allowMissingColumnNames) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -870,7 +870,7 @@ public CSVFormat withAllowMissingColumnNames(final boolean allowMissingColumnNam
      * @return A new CSVFormat that is equal to this but with the specified empty line skipping behavior.
      */
     public CSVFormat withIgnoreEmptyLines(final boolean ignoreEmptyLines) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -884,7 +884,7 @@ public CSVFormat withIgnoreEmptyLines(final boolean ignoreEmptyLines) {
      * @return A new CSVFormat that is equal to this but with the specified trimming behavior.
      */
     public CSVFormat withIgnoreSurroundingSpaces(final boolean ignoreSurroundingSpaces) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -905,7 +905,7 @@ public CSVFormat withIgnoreSurroundingSpaces(final boolean ignoreSurroundingSpac
      * @return A new CSVFormat that is equal to this but with the specified null conversion string.
      */
     public CSVFormat withNullString(final String nullString) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -936,7 +936,7 @@ public CSVFormat withQuote(final Character quoteChar) {
         if (isLineBreak(quoteChar)) {
             throw new IllegalArgumentException("The quoteChar cannot be a line break");
         }
-        return new CSVFormat(delimiter, quoteChar, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteChar, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -950,7 +950,7 @@ public CSVFormat withQuote(final Character quoteChar) {
      * @return A new CSVFormat that is equal to this but with the specified quote policy
      */
     public CSVFormat withQuoteMode(final QuoteMode quoteModePolicy) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteModePolicy, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteModePolicy, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -984,7 +984,7 @@ public CSVFormat withRecordSeparator(final char recordSeparator) {
      *              if recordSeparator is none of CR, LF or CRLF
      */
     public CSVFormat withRecordSeparator(final String recordSeparator) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
@@ -999,7 +999,7 @@ public CSVFormat withRecordSeparator(final String recordSeparator) {
      * @see #withHeader(String...)
      */
     public CSVFormat withSkipHeaderRecord(final boolean skipHeaderRecord) {
-        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentStartCharacter, escapeCharacter,
+        return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
                 ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
                 allowMissingColumnNames);
     }
diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/src/main/java/org/apache/commons/csv/CSVPrinter.java
@@ -297,13 +297,13 @@ private void printAndQuote(final Object object, final CharSequence value,
      *             If an I/O error occurs
      */
     public void printComment(final String comment) throws IOException {
-        if (!format.isCommentStartCharacterSet()) {
+        if (!format.isCommentMarkerSet()) {
             return;
         }
         if (!newRecord) {
             println();
         }
-        out.append(format.getCommentStartCharacter().charValue());
+        out.append(format.getCommentMarker().charValue());
         out.append(SP);
         for (int i = 0; i < comment.length(); i++) {
             final char c = comment.charAt(i);
@@ -315,7 +315,7 @@ public void printComment(final String comment) throws IOException {
                 //$FALL-THROUGH$ break intentionally excluded.
             case LF:
                 println();
-                out.append(format.getCommentStartCharacter().charValue());
+                out.append(format.getCommentMarker().charValue());
                 out.append(SP);
                 break;
             default:
diff --git a/src/main/java/org/apache/commons/csv/Lexer.java b/src/main/java/org/apache/commons/csv/Lexer.java
@@ -64,7 +64,7 @@ final class Lexer implements Closeable {
         this.delimiter = format.getDelimiter();
         this.escape = mapNullToDisabled(format.getEscapeCharacter());
         this.quoteChar = mapNullToDisabled(format.getQuoteCharacter());
-        this.commentStart = mapNullToDisabled(format.getCommentStartCharacter());
+        this.commentStart = mapNullToDisabled(format.getCommentMarker());
         this.ignoreSurroundingSpaces = format.getIgnoreSurroundingSpaces();
         this.ignoreEmptyLines = format.getIgnoreEmptyLines();
     }
diff --git a/src/test/java/org/apache/commons/csv/CSVFormatTest.java b/src/test/java/org/apache/commons/csv/CSVFormatTest.java
@@ -296,7 +296,7 @@ public void testQuotePolicyNoneWithoutEscapeThrowsException() {
 
     @Test
     public void testRFC4180() {
-        assertEquals(null, RFC4180.getCommentStartCharacter());
+        assertEquals(null, RFC4180.getCommentMarker());
         assertEquals(',', RFC4180.getDelimiter());
         assertEquals(null, RFC4180.getEscapeCharacter());
         assertFalse(RFC4180.getIgnoreEmptyLines());
@@ -321,7 +321,7 @@ public void testSerialization() throws Exception {
         assertNotNull(format);
         assertEquals("delimiter", CSVFormat.DEFAULT.getDelimiter(), format.getDelimiter());
         assertEquals("encapsulator", CSVFormat.DEFAULT.getQuoteCharacter(), format.getQuoteCharacter());
-        assertEquals("comment start", CSVFormat.DEFAULT.getCommentStartCharacter(), format.getCommentStartCharacter());
+        assertEquals("comment start", CSVFormat.DEFAULT.getCommentMarker(), format.getCommentMarker());
         assertEquals("record separator", CSVFormat.DEFAULT.getRecordSeparator(), format.getRecordSeparator());
         assertEquals("escape", CSVFormat.DEFAULT.getEscapeCharacter(), format.getEscapeCharacter());
         assertEquals("trim", CSVFormat.DEFAULT.getIgnoreSurroundingSpaces(), format.getIgnoreSurroundingSpaces());
@@ -331,7 +331,7 @@ public void testSerialization() throws Exception {
     @Test
     public void testWithCommentStart() throws Exception {
         final CSVFormat formatWithCommentStart = CSVFormat.DEFAULT.withCommentMarker('#');
-        assertEquals( Character.valueOf('#'), formatWithCommentStart.getCommentStartCharacter());
+        assertEquals( Character.valueOf('#'), formatWithCommentStart.getCommentMarker());
     }
 
     @Test(expected = IllegalArgumentException.class)
diff --git a/src/test/java/org/apache/commons/csv/CSVParserTest.java b/src/test/java/org/apache/commons/csv/CSVParserTest.java
@@ -274,7 +274,7 @@ public void testDefaultFormat() throws IOException {
         };
 
         CSVFormat format = CSVFormat.DEFAULT;
-        assertFalse(format.isCommentStartCharacterSet());
+        assertFalse(format.isCommentMarkerSet());
 
         CSVParser parser = CSVParser.parse(code, format);
         List<CSVRecord> records = parser.getRecords();

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ final class Lexer implements Closeable {`
`64`	`64`	`this.delimiter = format.getDelimiter();`
`65`	`65`	`this.escape = mapNullToDisabled(format.getEscapeCharacter());`
`66`	`66`	`this.quoteChar = mapNullToDisabled(format.getQuoteCharacter());`
`67`		`- this.commentStart = mapNullToDisabled(format.getCommentStartCharacter());`
	`67`	`+ this.commentStart = mapNullToDisabled(format.getCommentMarker());`
`68`	`68`	`this.ignoreSurroundingSpaces = format.getIgnoreSurroundingSpaces();`
`69`	`69`	`this.ignoreEmptyLines = format.getIgnoreEmptyLines();`
`70`	`70`	`}`