This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
The following commit(s) were added to refs/heads/master by this push:
new dd5de38 CSV-243 CSVFormat withTrim() and withIgnoreSurroundingSpaces()
dd5de38 is described below
commit dd5de3807215e1a38a2819027559e074c9e63d5a
Author: Sebb <s...@apache.org>
AuthorDate: Fri Jun 14 22:56:30 2019 +0100
CSV-243 CSVFormat withTrim() and withIgnoreSurroundingSpaces()
need better docs
---
src/changes/changes.xml | 1 +
src/main/java/org/apache/commons/csv/CSVFormat.java | 14 +++++++-------
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index d07c370..5294e07 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -39,6 +39,7 @@
</properties>
<body>
<release version="1.8" date="2019-MM-DD" description="Feature and bug fix
release (Java 8)">
+ <action issue="CSV-243" type="fix" dev="sebb">CSVFormat withTrim() and
withIgnoreSurroundingSpaces() need better docs</action>
<action issue="CSV-242" type="fix" dev="sebb">CSVFormat equals() and
hashCode() don't use all fields</action>
<action issue="CSV-241" type="fix" dev="ggregory" due-to="LuckyIlam,
Gary Gregory">CSVFormat#valiadte() does not account for
allowDuplicateHeaderNames #43.</action>
</release>
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java
b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 122f906..1111762 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -2092,9 +2092,9 @@ public final class CSVFormat implements Serializable {
}
/**
- * Returns a new {@code CSVFormat} with the trimming behavior of the
format set to {@code true}.
+ * Returns a new {@code CSVFormat} with the parser trimming behavior of
the format set to {@code true}.
*
- * @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
parser trimming behavior.
* @see #withIgnoreSurroundingSpaces(boolean)
* @since 1.1
*/
@@ -2103,10 +2103,10 @@ public final class CSVFormat implements Serializable {
}
/**
- * Returns a new {@code CSVFormat} with the trimming behavior of the
format set to the given value.
+ * Returns a new {@code CSVFormat} with the parser trimming behavior of
the format set to the given value.
*
* @param ignoreSurroundingSpaces
- * the trimming behavior, {@code true} to remove the
surrounding spaces, {@code false} to leave the
+ * the parser trimming behavior, {@code true} to remove the
surrounding spaces, {@code false} to leave the
* spaces as is.
* @return A new CSVFormat that is equal to this but with the specified
trimming behavior.
*/
@@ -2294,7 +2294,7 @@ public final class CSVFormat implements Serializable {
}
/**
- * Returns a new {@code CSVFormat} to trim leading and trailing blanks.
+ * Returns a new {@code CSVFormat} to trim leading and trailing blanks
when printing.
*
* @return A new CSVFormat that is equal to this but with the trim setting
on.
* @since 1.3
@@ -2304,10 +2304,10 @@ public final class CSVFormat implements Serializable {
}
/**
- * Returns a new {@code CSVFormat} with whether to trim leading and
trailing blanks.
+ * Returns a new {@code CSVFormat} with whether to trim leading and
trailing blanks when printing.
*
* @param trim
- * whether to trim leading and trailing blanks.
+ * whether to trim leading and trailing blanks when printing.
*
* @return A new CSVFormat that is equal to this but with the specified
trim setting.
* @since 1.3
