CSV-243 CSVFormat withTrim() and withIgnoreSurroundingSpaces()

sebbASF · sebbASF · commit dd5de3807215 · 2019-06-14T22:56:30.000+01:00
need better docs
diff --git 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
@@ -2092,9 +2092,9 @@ public CSVFormat withIgnoreHeaderCase(final boolean ignoreHeaderCase) {
     }
 
     /**
-     * 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 CSVFormat withIgnoreSurroundingSpaces() {
     }
 
     /**
-     * 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 CSVFormat withTrailingDelimiter(final boolean trailingDelimiter) {
     }
 
     /**
-     * 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 CSVFormat withTrim() {
     }
 
     /**
-     * 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

Original file line number	Diff line number	Diff line change
`@@ -2092,9 +2092,9 @@ public CSVFormat withIgnoreHeaderCase(final boolean ignoreHeaderCase) {`
`2092`	`2092`	`}`
`2093`	`2093`
`2094`	`2094`	`/**`
`2095`		`- * Returns a new {@code CSVFormat} with the trimming behavior of the format set to {@code true}.`
	`2095`	`+ * Returns a new {@code CSVFormat} with the parser trimming behavior of the format set to {@code true}.`
`2096`	`2096`	`*`
`2097`		`- * @return A new CSVFormat that is equal to this but with the specified trimming behavior.`
	`2097`	`+ * @return A new CSVFormat that is equal to this but with the specified parser trimming behavior.`
`2098`	`2098`	`* @see #withIgnoreSurroundingSpaces(boolean)`
`2099`	`2099`	`* @since 1.1`
`2100`	`2100`	`*/`
`@@ -2103,10 +2103,10 @@ public CSVFormat withIgnoreSurroundingSpaces() {`
`2103`	`2103`	`}`
`2104`	`2104`
`2105`	`2105`	`/**`
`2106`		`- * Returns a new {@code CSVFormat} with the trimming behavior of the format set to the given value.`
	`2106`	`+ * Returns a new {@code CSVFormat} with the parser trimming behavior of the format set to the given value.`
`2107`	`2107`	`*`
`2108`	`2108`	`* @param ignoreSurroundingSpaces`
`2109`		`- * the trimming behavior, {@code true} to remove the surrounding spaces, {@code false} to leave the`
	`2109`	`+ * the parser trimming behavior, {@code true} to remove the surrounding spaces, {@code false} to leave the`
`2110`	`2110`	`* spaces as is.`
`2111`	`2111`	`* @return A new CSVFormat that is equal to this but with the specified trimming behavior.`
`2112`	`2112`	`*/`
`@@ -2294,7 +2294,7 @@ public CSVFormat withTrailingDelimiter(final boolean trailingDelimiter) {`
`2294`	`2294`	`}`
`2295`	`2295`
`2296`	`2296`	`/**`
`2297`		`- * Returns a new {@code CSVFormat} to trim leading and trailing blanks.`
	`2297`	`+ * Returns a new {@code CSVFormat} to trim leading and trailing blanks when printing.`
`2298`	`2298`	`*`
`2299`	`2299`	`* @return A new CSVFormat that is equal to this but with the trim setting on.`
`2300`	`2300`	`* @since 1.3`
`@@ -2304,10 +2304,10 @@ public CSVFormat withTrim() {`
`2304`	`2304`	`}`
`2305`	`2305`
`2306`	`2306`	`/**`
`2307`		`- * Returns a new {@code CSVFormat} with whether to trim leading and trailing blanks.`
	`2307`	`+ * Returns a new {@code CSVFormat} with whether to trim leading and trailing blanks when printing.`
`2308`	`2308`	`*`
`2309`	`2309`	`* @param trim`
`2310`		`- * whether to trim leading and trailing blanks.`
	`2310`	`+ * whether to trim leading and trailing blanks when printing.`
`2311`	`2311`	`*`
`2312`	`2312`	`* @return A new CSVFormat that is equal to this but with the specified trim setting.`
`2313`	`2313`	`* @since 1.3`