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

Javadoc formatting.

This commit is contained in:
aherbert 2020-01-21 13:07:19 +00:00
parent 12a2ff42d3
commit 7ff3e14813
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -83,11 +83,13 @@ public final class CSVRecord implements Serializable, Iterable<String> {
/** /**
* Returns a value by name. * Returns a value by name.
* *
* <p>Note: This requires a field mapping obtained from the original parser. * <p>
* Note: This requires a field mapping obtained from the original parser.
* A check using {@link #isMapped(String)} should be used to determine if a * A check using {@link #isMapped(String)} should be used to determine if a
* mapping exists from the provide {@code name} to a field index. In this case an * mapping exists from the provided {@code name} to a field index. In this case an
* exception will only be thrown if the record does not contain a field corresponding * exception will only be thrown if the record does not contain a field corresponding
* to the mapping, that is the record length is not consistent with the mapping size. * to the mapping, that is the record length is not consistent with the mapping size.
* </p>
* *
* @param name * @param name
* the name of the column to be retrieved. * the name of the column to be retrieved.
@ -150,8 +152,10 @@ public final class CSVRecord implements Serializable, Iterable<String> {
/** /**
* Returns the parser. * Returns the parser.
* *
* <p>Note: The parser is not part of the serialized state of the record. A null check * <p>
* Note: The parser is not part of the serialized state of the record. A null check
* should be used when the record may have originated from a serialized form. * should be used when the record may have originated from a serialized form.
* </p>
* *
* @return the parser. * @return the parser.
* @since 1.7 * @since 1.7

4
src/test/java/org/apache/commons/csv/issues/JiraCsv248Test.java
View File

@ -31,7 +31,7 @@ import java.io.ObjectInputStream;
public class JiraCsv248Test { public class JiraCsv248Test {
/** /**
* Test deserialisation of a CSVRecord create using version 1.6. * Test deserialisation of a CSVRecord created using version 1.6.
* *
* <p>This test asserts that serialization from 1.8 onwards is consistent with * <p>This test asserts that serialization from 1.8 onwards is consistent with
* previous versions. Serialization was broken in version 1.7. * previous versions. Serialization was broken in version 1.7.
@ -77,4 +77,4 @@ public class JiraCsv248Test {
private static InputStream getTestInput() { private static InputStream getTestInput() {
return ClassLoader.getSystemClassLoader().getResourceAsStream("CSV-248/csvRecord.bin"); return ClassLoader.getSystemClassLoader().getResourceAsStream("CSV-248/csvRecord.bin");
} }
} }