Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Restore commentMarker property which was overridden during refactoring 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1612390 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2014-07-21 19:42:40 +00:00
parent f9a3162037
commit 67d150adc8
5 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
src/main/java/org/apache/commons/csv/CSVFormat.java
View File

@ -149,7 +149,7 @@ public final class CSVFormat implements Serializable {
private final char delimiter; private final char delimiter;
private final Character quoteCharacter; // null if quoting is disabled private final Character quoteCharacter; // null if quoting is disabled
private final QuoteMode quoteMode; 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 Character escapeCharacter; // null if escaping is disabled
private final boolean ignoreSurroundingSpaces; // Should leading/trailing spaces be ignored around values? private final boolean ignoreSurroundingSpaces; // Should leading/trailing spaces be ignored around values?
private final boolean allowMissingColumnNames; private final boolean allowMissingColumnNames;
@ -345,7 +345,7 @@ public final class CSVFormat implements Serializable {
this.delimiter = delimiter; this.delimiter = delimiter;
this.quoteCharacter = quoteChar; this.quoteCharacter = quoteChar;
this.quoteMode = quoteMode; this.quoteMode = quoteMode;
this.commentStartCharacter = commentStart; this.commentMarker = commentStart;
this.escapeCharacter = escape; this.escapeCharacter = escape;
this.ignoreSurroundingSpaces = ignoreSurroundingSpaces; this.ignoreSurroundingSpaces = ignoreSurroundingSpaces;
this.allowMissingColumnNames = allowMissingColumnNames; this.allowMissingColumnNames = allowMissingColumnNames;
@ -394,11 +394,11 @@ public final class CSVFormat implements Serializable {
} else if (!quoteCharacter.equals(other.quoteCharacter)) { } else if (!quoteCharacter.equals(other.quoteCharacter)) {
return false; return false;
} }
if (commentStartCharacter == null) { if (commentMarker == null) {
if (other.commentStartCharacter != null) { if (other.commentMarker != null) {
return false; return false;
} }
} else if (!commentStartCharacter.equals(other.commentStartCharacter)) { } else if (!commentMarker.equals(other.commentMarker)) {
return false; return false;
} }
if (escapeCharacter == null) { if (escapeCharacter == null) {
@ -460,8 +460,8 @@ public final class CSVFormat implements Serializable {
* *
* @return the comment start marker, may be {@code null} * @return the comment start marker, may be {@code null}
*/ */
public Character getCommentStartCharacter() { public Character getCommentMarker() {
return commentStartCharacter; return commentMarker;
} }
/** /**
@ -583,7 +583,7 @@ public final class CSVFormat implements Serializable {
result = prime * result + delimiter; result = prime * result + delimiter;
result = prime * result + ((quoteMode == null) ? 0 : quoteMode.hashCode()); result = prime * result + ((quoteMode == null) ? 0 : quoteMode.hashCode());
result = prime * result + ((quoteCharacter == null) ? 0 : quoteCharacter.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 + ((escapeCharacter == null) ? 0 : escapeCharacter.hashCode());
result = prime * result + ((nullString == null) ? 0 : nullString.hashCode()); result = prime * result + ((nullString == null) ? 0 : nullString.hashCode());
result = prime * result + (ignoreSurroundingSpaces ? 1231 : 1237); result = prime * result + (ignoreSurroundingSpaces ? 1231 : 1237);
@ -601,8 +601,8 @@ public final class CSVFormat implements Serializable {
* *
* @return {@code true} is comments are supported, {@code false} otherwise * @return {@code true} is comments are supported, {@code false} otherwise
*/ */
public boolean isCommentStartCharacterSet() { public boolean isCommentMarkerSet() {
return commentStartCharacter != null; return commentMarker != null;
} }
/** /**
@ -678,9 +678,9 @@ public final class CSVFormat implements Serializable {
sb.append(' '); sb.append(' ');
sb.append("QuoteChar=<").append(quoteCharacter).append('>'); sb.append("QuoteChar=<").append(quoteCharacter).append('>');
} }
if (isCommentStartCharacterSet()) { if (isCommentMarkerSet()) {
sb.append(' '); sb.append(' ');
sb.append("CommentStart=<").append(commentStartCharacter).append('>'); sb.append("CommentStart=<").append(commentMarker).append('>');
} }
if (isNullStringSet()) { if (isNullStringSet()) {
sb.append(' '); sb.append(' ');
@ -720,19 +720,19 @@ public final class CSVFormat implements Serializable {
"The escape character and the delimiter cannot be the same ('" + escapeCharacter + "')"); "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( 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( 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( 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) { if (escapeCharacter == null && quoteMode == QuoteMode.NONE) {
@ -788,7 +788,7 @@ public final class CSVFormat implements Serializable {
if (isLineBreak(delimiter)) { if (isLineBreak(delimiter)) {
throw new IllegalArgumentException("The delimiter cannot be a line break"); 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -819,7 +819,7 @@ public final class CSVFormat implements Serializable {
if (isLineBreak(escape)) { if (isLineBreak(escape)) {
throw new IllegalArgumentException("The escape character cannot be a line break"); 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -842,7 +842,7 @@ public final class CSVFormat implements Serializable {
* @see #withSkipHeaderRecord(boolean) * @see #withSkipHeaderRecord(boolean)
*/ */
public CSVFormat withHeader(final String... header) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -856,7 +856,7 @@ public final class CSVFormat implements Serializable {
* @return A new CSVFormat that is equal to this but with the specified missing column names behavior. * @return A new CSVFormat that is equal to this but with the specified missing column names behavior.
*/ */
public CSVFormat withAllowMissingColumnNames(final boolean allowMissingColumnNames) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -870,7 +870,7 @@ public final class CSVFormat implements Serializable {
* @return A new CSVFormat that is equal to this but with the specified empty line skipping behavior. * @return A new CSVFormat that is equal to this but with the specified empty line skipping behavior.
*/ */
public CSVFormat withIgnoreEmptyLines(final boolean ignoreEmptyLines) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -884,7 +884,7 @@ public final class CSVFormat implements Serializable {
* @return A new CSVFormat that is equal to this but with the specified trimming behavior. * @return A new CSVFormat that is equal to this but with the specified trimming behavior.
*/ */
public CSVFormat withIgnoreSurroundingSpaces(final boolean ignoreSurroundingSpaces) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -905,7 +905,7 @@ public final class CSVFormat implements Serializable {
* @return A new CSVFormat that is equal to this but with the specified null conversion string. * @return A new CSVFormat that is equal to this but with the specified null conversion string.
*/ */
public CSVFormat withNullString(final String nullString) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -936,7 +936,7 @@ public final class CSVFormat implements Serializable {
if (isLineBreak(quoteChar)) { if (isLineBreak(quoteChar)) {
throw new IllegalArgumentException("The quoteChar cannot be a line break"); 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -950,7 +950,7 @@ public final class CSVFormat implements Serializable {
* @return A new CSVFormat that is equal to this but with the specified quote policy * @return A new CSVFormat that is equal to this but with the specified quote policy
*/ */
public CSVFormat withQuoteMode(final QuoteMode quoteModePolicy) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -984,7 +984,7 @@ public final class CSVFormat implements Serializable {
* if recordSeparator is none of CR, LF or CRLF * if recordSeparator is none of CR, LF or CRLF
*/ */
public CSVFormat withRecordSeparator(final String recordSeparator) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }
@ -999,7 +999,7 @@ public final class CSVFormat implements Serializable {
* @see #withHeader(String...) * @see #withHeader(String...)
*/ */
public CSVFormat withSkipHeaderRecord(final boolean skipHeaderRecord) { 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, ignoreSurroundingSpaces, ignoreEmptyLines, recordSeparator, nullString, header, skipHeaderRecord,
allowMissingColumnNames); allowMissingColumnNames);
} }

6
src/main/java/org/apache/commons/csv/CSVPrinter.java
View File

@ -297,13 +297,13 @@ public final class CSVPrinter implements Flushable, Closeable {
* If an I/O error occurs * If an I/O error occurs
*/ */
public void printComment(final String comment) throws IOException { public void printComment(final String comment) throws IOException {
if (!format.isCommentStartCharacterSet()) { if (!format.isCommentMarkerSet()) {
return; return;
} }
if (!newRecord) { if (!newRecord) {
println(); println();
} }
out.append(format.getCommentStartCharacter().charValue()); out.append(format.getCommentMarker().charValue());
out.append(SP); out.append(SP);
for (int i = 0; i < comment.length(); i++) { for (int i = 0; i < comment.length(); i++) {
final char c = comment.charAt(i); final char c = comment.charAt(i);
@ -315,7 +315,7 @@ public final class CSVPrinter implements Flushable, Closeable {
//$FALL-THROUGH$ break intentionally excluded. //$FALL-THROUGH$ break intentionally excluded.
case LF: case LF:
println(); println();
out.append(format.getCommentStartCharacter().charValue()); out.append(format.getCommentMarker().charValue());
out.append(SP); out.append(SP);
break; break;
default: default:

2
src/main/java/org/apache/commons/csv/Lexer.java
View File

@ -64,7 +64,7 @@ final class Lexer implements Closeable {
this.delimiter = format.getDelimiter(); this.delimiter = format.getDelimiter();
this.escape = mapNullToDisabled(format.getEscapeCharacter()); this.escape = mapNullToDisabled(format.getEscapeCharacter());
this.quoteChar = mapNullToDisabled(format.getQuoteCharacter()); this.quoteChar = mapNullToDisabled(format.getQuoteCharacter());
this.commentStart = mapNullToDisabled(format.getCommentStartCharacter()); this.commentStart = mapNullToDisabled(format.getCommentMarker());
this.ignoreSurroundingSpaces = format.getIgnoreSurroundingSpaces(); this.ignoreSurroundingSpaces = format.getIgnoreSurroundingSpaces();
this.ignoreEmptyLines = format.getIgnoreEmptyLines(); this.ignoreEmptyLines = format.getIgnoreEmptyLines();
} }

6
src/test/java/org/apache/commons/csv/CSVFormatTest.java
View File

@ -296,7 +296,7 @@ public class CSVFormatTest {
@Test @Test
public void testRFC4180() { public void testRFC4180() {
assertEquals(null, RFC4180.getCommentStartCharacter()); assertEquals(null, RFC4180.getCommentMarker());
assertEquals(',', RFC4180.getDelimiter()); assertEquals(',', RFC4180.getDelimiter());
assertEquals(null, RFC4180.getEscapeCharacter()); assertEquals(null, RFC4180.getEscapeCharacter());
assertFalse(RFC4180.getIgnoreEmptyLines()); assertFalse(RFC4180.getIgnoreEmptyLines());
@ -321,7 +321,7 @@ public class CSVFormatTest {
assertNotNull(format); assertNotNull(format);
assertEquals("delimiter", CSVFormat.DEFAULT.getDelimiter(), format.getDelimiter()); assertEquals("delimiter", CSVFormat.DEFAULT.getDelimiter(), format.getDelimiter());
assertEquals("encapsulator", CSVFormat.DEFAULT.getQuoteCharacter(), format.getQuoteCharacter()); 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("record separator", CSVFormat.DEFAULT.getRecordSeparator(), format.getRecordSeparator());
assertEquals("escape", CSVFormat.DEFAULT.getEscapeCharacter(), format.getEscapeCharacter()); assertEquals("escape", CSVFormat.DEFAULT.getEscapeCharacter(), format.getEscapeCharacter());
assertEquals("trim", CSVFormat.DEFAULT.getIgnoreSurroundingSpaces(), format.getIgnoreSurroundingSpaces()); assertEquals("trim", CSVFormat.DEFAULT.getIgnoreSurroundingSpaces(), format.getIgnoreSurroundingSpaces());
@ -331,7 +331,7 @@ public class CSVFormatTest {
@Test @Test
public void testWithCommentStart() throws Exception { public void testWithCommentStart() throws Exception {
final CSVFormat formatWithCommentStart = CSVFormat.DEFAULT.withCommentMarker('#'); final CSVFormat formatWithCommentStart = CSVFormat.DEFAULT.withCommentMarker('#');
assertEquals( Character.valueOf('#'), formatWithCommentStart.getCommentStartCharacter()); assertEquals( Character.valueOf('#'), formatWithCommentStart.getCommentMarker());
} }
@Test(expected = IllegalArgumentException.class) @Test(expected = IllegalArgumentException.class)

2
src/test/java/org/apache/commons/csv/CSVParserTest.java
View File

@ -274,7 +274,7 @@ public class CSVParserTest {
}; };
CSVFormat format = CSVFormat.DEFAULT; CSVFormat format = CSVFormat.DEFAULT;
assertFalse(format.isCommentStartCharacterSet()); assertFalse(format.isCommentMarkerSet());
CSVParser parser = CSVParser.parse(code, format); CSVParser parser = CSVParser.parse(code, format);
List<CSVRecord> records = parser.getRecords(); List<CSVRecord> records = parser.getRecords();