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

CSV-243 CSVFormat withTrim() and withIgnoreSurroundingSpaces() 

need better docs
This commit is contained in:
Sebb 2019-06-14 22:56:30 +01:00
parent ed8602db29
commit dd5de38072
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -39,6 +39,7 @@
</properties> </properties>
<body> <body>
<release version="1.8" date="2019-MM-DD" description="Feature and bug fix release (Java 8)"> <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-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> <action issue="CSV-241" type="fix" dev="ggregory" due-to="LuckyIlam, Gary Gregory">CSVFormat#valiadte() does not account for allowDuplicateHeaderNames #43.</action>
</release> </release>

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

@ -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) * @see #withIgnoreSurroundingSpaces(boolean)
* @since 1.1 * @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 * @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. * spaces as is.
* @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.
*/ */
@ -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. * @return A new CSVFormat that is equal to this but with the trim setting on.
* @since 1.3 * @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 * @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. * @return A new CSVFormat that is equal to this but with the specified trim setting.
* @since 1.3 * @since 1.3