Skip to content

Commit 3f0faa0

Browse files
committed
Add missing JavaDoc
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1459020 13f79535-47bb-0310-9956-ffa450edef68
1 parent b53a171 commit 3f0faa0

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

src/main/java/org/apache/commons/csv/CSVRecord.java

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import java.util.Map;
2424

2525
/**
26-
* A CSV record
26+
* A CSV record parsed from a CSV file.
2727
*
2828
* @version $Id$
2929
*/
@@ -103,6 +103,11 @@ public boolean isSet(final String name) {
103103
return isMapped(name) && mapping.get(name).intValue() < values.length;
104104
}
105105

106+
/**
107+
* Returns an iterator over the values of this record.
108+
*
109+
* @return an iterator over the values of this record.
110+
*/
106111
public Iterator<String> iterator() {
107112
return Arrays.asList(values).iterator();
108113
}
@@ -111,16 +116,29 @@ String[] values() {
111116
return values;
112117
}
113118

119+
/**
120+
* Returns the comment for this record, if any.
121+
*
122+
* @return the comment for this record, or null if no comment for this
123+
* record is available.
124+
*/
114125
public String getComment() {
115126
return comment;
116127
}
117128

129+
/**
130+
* Returns the number of this record in the parsed CSV file.
131+
*
132+
* @return the number of this record.
133+
*/
118134
public long getRecordNumber() {
119135
return recordNumber;
120136
}
121137

122138
/**
123139
* Returns the number of values in this record.
140+
*
141+
* @return the number of values.
124142
*/
125143
public int size() {
126144
return values.length;

0 commit comments

Comments
 (0)