Skip to content

Commit

Permalink
Javadoc formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
aherbert committed Jan 21, 2020
1 parent 12a2ff4 commit 7ff3e14
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
10 changes: 7 additions & 3 deletions src/main/java/org/apache/commons/csv/CSVRecord.java
Expand Up @@ -83,11 +83,13 @@ public String get(final int i) {
/**
* 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
* 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
* to the mapping, that is the record length is not consistent with the mapping size.
* </p>
*
* @param name
* the name of the column to be retrieved.
Expand Down Expand Up @@ -150,8 +152,10 @@ private Map<String, Integer> getHeaderMapRaw() {
/**
* 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.
* </p>
*
* @return the parser.
* @since 1.7
Expand Down
Expand Up @@ -31,7 +31,7 @@

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
* previous versions. Serialization was broken in version 1.7.
Expand Down Expand Up @@ -77,4 +77,4 @@ public void testJiraCsv248() throws IOException, ClassNotFoundException {
private static InputStream getTestInput() {
return ClassLoader.getSystemClassLoader().getResourceAsStream("CSV-248/csvRecord.bin");
}
}
}

0 comments on commit 7ff3e14

Please sign in to comment.