CSV-216: Avoid references to CSVMutableRecord
as mutator functions are directly in CSVRecord
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 @@
* @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 @@
}
/**
- * 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,
