CSV-216: Avoid references to CSVMutableRecord as mutator functions are directly in CSVRecord
Project: http://git-wip-us.apache.org/repos/asf/commons-csv/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-csv/commit/6eebeb04 Tree: http://git-wip-us.apache.org/repos/asf/commons-csv/tree/6eebeb04 Diff: http://git-wip-us.apache.org/repos/asf/commons-csv/diff/6eebeb04 Branch: refs/heads/CSV-216-with Commit: 6eebeb0480a2376e928214e08e1279f0c337aad9 Parents: bb949ad Author: Stian Soiland-Reyes <st...@apache.org> Authored: Fri Feb 9 16:09:19 2018 +0000 Committer: Stian Soiland-Reyes <st...@apache.org> Committed: Fri Feb 9 16:09:19 2018 +0000 ---------------------------------------------------------------------- src/main/java/org/apache/commons/csv/CSVFormat.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-csv/blob/6eebeb04/src/main/java/org/apache/commons/csv/CSVFormat.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index 2292081..6a0713d 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -626,7 +626,7 @@ public final class CSVFormat implements Serializable { * @param autoFlush * TODO * @param mutableRecords - * if {@code true}, return {@link CSVMutableRecord} + * if {@code true}, {@link CSVRecord}s are {@link CSVRecord#mutable()} by default, otherwise immutable * * @throws IllegalArgumentException * if the delimiter is a line break character @@ -1808,16 +1808,16 @@ public final class CSVFormat implements Serializable { } /** - * Returns a new {@code CSVFormat} with whether to generate CSVRecord or CSVMutableRecord. + * Returns a new {@code CSVFormat} with mutable or immutable records by default. * <ul> - * <li><strong>Reading:</strong> Whether to generate CSVRecord or CSVMutableRecord.</li> + * <li><strong>Reading:</strong> Mutable by default.</li> * <li><strong>Writing:</strong> No effect.</li> * </ul> * * @param mutableRecords - * whether to generate CSVRecord or CSVMutableRecord + * If true, parsed @link CSVRecord}s are {@link CSVRecord#mutable()}, otherwise {@link CSVRecord#immutable()}. * - * @return A new CSVFormat that is equal to this but with setting to generate CSVRecord or CSVMutableRecord. + * @return A new CSVFormat that is equal to this but with setting to generate mutable/immutable records. */ public CSVFormat withMutableRecords(final boolean mutableRecords) { return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,
