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

Document intent to remove Serializable from CSVRecord. 

This was added to the class header and the changes.xml for inclusion in
the release notes.
This commit is contained in:
Alex Herbert 2020-01-27 21:48:27 +00:00
parent b7fea5546b
commit 70092bb303
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/changes/changes.xml
View File

@ -38,7 +38,12 @@
<title>Apache Commons CSV Release Notes</title>
</properties>
<body>
<release version="1.8" date="2019-01-DD" description="Feature and bug fix release (Java 8)">
<release version="1.8" date="2019-01-DD" description="Feature and bug fix release (Java 8).
This release fixes serialization compatibility of CSVRecord with versions 1.0 to 1.6.
New fields added since 1.7 are not serialized. Support for Serializable is scheduled to be
removed in version 2.0.
">
<action issue="CSV-255" type="add" dev="ggregory" due-to="0x100">Add CSVRecord.isSet(int) method #52.</action>
<action issue="CSV-135" type="fix" dev="sebb" due-to="Mateusz Zakarczemny">Char escape doesn't work properly with quoting.</action>
<action issue="CSV-244" type="fix" dev="sebb">Test case failures following CSVFormat#equals() update.</action>

11
src/main/java/org/apache/commons/csv/CSVRecord.java
View File

@ -28,6 +28,15 @@ import java.util.Objects;
/**
* A CSV record parsed from a CSV file.
*
* <p>
* Note: Support for {@link Serializable} is scheduled to be removed in version 2.0.
* In version 1.8 the mapping between the column header and the column index was
* removed from the serialised state. The class maintains serialization compatibility
* with versions pre-1.8 for the record values; these must be accessed by index
* following deserialization. There will be loss of any functionally linked to the header
* mapping when transferring serialised forms pre-1.8 to 1.8 and vice versa.
* </p>
*/
public final class CSVRecord implements Serializable, Iterable<String> {
@ -46,7 +55,7 @@ public final class CSVRecord implements Serializable, Iterable<String> {
/** The values of the record */
private final String[] values;
/** The parser that originates this record. */
/** The parser that originates this record. This is not serialized. */
private final transient CSVParser parser;
CSVRecord(final CSVParser parser, final String[] values, final String comment, final long recordNumber,