Document existing behaviour

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1304503 13f79535-47bb-0310-9956-ffa450edef68
2012-03-23 17:22:22 +00:00 · 2012-03-23 17:22:22 +00:00 · 4406fba31c
parent 37a261b385
commit 4406fba31c
1 changed files with 3 additions and 1 deletions
--- a/src/main/java/org/apache/commons/csv/CSVRecord.java
+++ b/src/main/java/org/apache/commons/csv/CSVRecord.java
@ -54,7 +54,9 @@ public class CSVRecord implements Serializable, Iterable<String> {
    /**
     * Returns a value by name.
     *
-     * @param name the name of the column retrieved
+     * @param name the name of the column to be retrieved
+     * @return the column value, or {@code null} if the column name is not found
+     * @throws IllegalStateException if no header mapping was provided
     */
    public String get(String name) {
        if (mapping == null) {