Author: sebb
Date: Fri Mar 23 17:22:22 2012
New Revision: 1304503
URL: http://svn.apache.org/viewvc?rev=1304503&view=rev
Log:
Document existing behaviour
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java
Modified:
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java
URL:
http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java?rev=1304503&r1=1304502&r2=1304503&view=diff
==============================================================================
---
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java
(original)
+++
commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java
Fri Mar 23 17:22:22 2012
@@ -54,7 +54,9 @@ public class CSVRecord implements Serial
/**
* 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) {
