Add missing JavaDoc

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1459020 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2013-03-20 19:52:27 +00:00
parent b53a171ab3
commit 3f0faa00ed
1 changed files with 19 additions and 1 deletions

View File

@ -23,7 +23,7 @@ import java.util.Iterator;
import java.util.Map;
/**
* A CSV record
* A CSV record parsed from a CSV file.
*
* @version $Id$
*/
@ -103,6 +103,11 @@ public class CSVRecord implements Serializable, Iterable<String> {
return isMapped(name) && mapping.get(name).intValue() < values.length;
}
/**
* Returns an iterator over the values of this record.
*
* @return an iterator over the values of this record.
*/
public Iterator<String> iterator() {
return Arrays.asList(values).iterator();
}
@ -111,16 +116,29 @@ public class CSVRecord implements Serializable, Iterable<String> {
return values;
}
/**
* Returns the comment for this record, if any.
*
* @return the comment for this record, or null if no comment for this
* record is available.
*/
public String getComment() {
return comment;
}
/**
* Returns the number of this record in the parsed CSV file.
*
* @return the number of this record.
*/
public long getRecordNumber() {
return recordNumber;
}
/**
* Returns the number of values in this record.
*
* @return the number of values.
*/
public int size() {
return values.length;