Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

Commit 6eebeb0

Browse files
committed
CSV-216: Avoid references to CSVMutableRecord
as mutator functions are directly in CSVRecord
1 parent bb949ad commit 6eebeb0

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

src/main/java/org/apache/commons/csv/CSVFormat.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@ public static CSVFormat valueOf(final String format) {
626626
* @param autoFlush
627627
* TODO
628628
* @param mutableRecords
629-
* if {@code true}, return {@link CSVMutableRecord}
629+
* if {@code true}, {@link CSVRecord}s are {@link CSVRecord#mutable()} by default, otherwise immutable
630630
*
631631
* @throws IllegalArgumentException
632632
* if the delimiter is a line break character
@@ -1808,16 +1808,16 @@ public CSVFormat withIgnoreSurroundingSpaces(final boolean ignoreSurroundingSpac
18081808
}
18091809

18101810
/**
1811-
* Returns a new {@code CSVFormat} with whether to generate CSVRecord or CSVMutableRecord.
1811+
* Returns a new {@code CSVFormat} with mutable or immutable records by default.
18121812
* <ul>
1813-
* <li><strong>Reading:</strong> Whether to generate CSVRecord or CSVMutableRecord.</li>
1813+
* <li><strong>Reading:</strong> Mutable by default.</li>
18141814
* <li><strong>Writing:</strong> No effect.</li>
18151815
* </ul>
18161816
*
18171817
* @param mutableRecords
1818-
* whether to generate CSVRecord or CSVMutableRecord
1818+
* If true, parsed @link CSVRecord}s are {@link CSVRecord#mutable()}, otherwise {@link CSVRecord#immutable()}.
18191819
*
1820-
* @return A new CSVFormat that is equal to this but with setting to generate CSVRecord or CSVMutableRecord.
1820+
* @return A new CSVFormat that is equal to this but with setting to generate mutable/immutable records.
18211821
*/
18221822
public CSVFormat withMutableRecords(final boolean mutableRecords) {
18231823
return new CSVFormat(delimiter, quoteCharacter, quoteMode, commentMarker, escapeCharacter,

0 commit comments

Comments
 (0)