Skip to content

Commit d10442b

Browse files
committed
Javadoc.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1461240 13f79535-47bb-0310-9956-ffa450edef68
1 parent 9107316 commit d10442b

3 files changed

Lines changed: 10 additions & 1 deletion

File tree

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,7 @@ String[] getHeader() {
353353
* the input stream
354354
* @return a stream of CSVRecord
355355
* @throws IOException
356+
* If an I/O error occurs
356357
*/
357358
public Iterable<CSVRecord> parse(final Reader in) throws IOException {
358359
return new CSVParser(in, this);
@@ -599,7 +600,8 @@ public CSVFormat build() {
599600
* @param in
600601
* the input stream
601602
* @return a CSVRecord stream
602-
* @throws IOException
603+
* @throws IOException
604+
* If an I/O error occurs
603605
*/
604606
public Iterable<CSVRecord> parse(final Reader in) throws IOException {
605607
return this.build().parse(in);

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ public class CSVParser implements Iterable<CSVRecord> {
9999
* a Reader containing "csv-formatted" input
100100
* @throws IllegalArgumentException
101101
* thrown if the parameters of the format are inconsistent
102+
* @throws IOException
103+
* If an I/O error occurs
102104
*/
103105
public CSVParser(final Reader input) throws IOException {
104106
this(input, CSVFormat.DEFAULT);
@@ -113,6 +115,8 @@ public CSVParser(final Reader input) throws IOException {
113115
* the CSVFormat used for CSV parsing
114116
* @throws IllegalArgumentException
115117
* thrown if the parameters of the format are inconsistent
118+
* @throws IOException
119+
* If an I/O error occurs
116120
*/
117121
public CSVParser(final Reader input, final CSVFormat format) throws IOException {
118122
this.lexer = new CSVLexer(format, new ExtendedBufferedReader(input));
@@ -128,6 +132,8 @@ public CSVParser(final Reader input, final CSVFormat format) throws IOException
128132
* the CSVFormat used for CSV parsing
129133
* @throws IllegalArgumentException
130134
* thrown if the parameters of the format are inconsistent
135+
* @throws IOException
136+
* If an I/O error occurs
131137
*/
132138
public CSVParser(final String input, final CSVFormat format) throws IOException {
133139
this(new StringReader(input), format);

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ public void println() throws IOException {
8080
* Flushes the underlying stream.
8181
*
8282
* @throws IOException
83+
* If an I/O error occurs
8384
*/
8485
public void flush() throws IOException {
8586
if (out instanceof Flushable) {

0 commit comments

Comments
 (0)