From d10442b68a673444a3d6716d2d7f1cf98618ce05 Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Tue, 26 Mar 2013 17:48:22 +0000 Subject: [PATCH] Javadoc. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1461240 13f79535-47bb-0310-9956-ffa450edef68 --- src/main/java/org/apache/commons/csv/CSVFormat.java | 4 +++- src/main/java/org/apache/commons/csv/CSVParser.java | 6 ++++++ src/main/java/org/apache/commons/csv/CSVPrinter.java | 1 + 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index 2416e13c..1a3b0fbe 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -353,6 +353,7 @@ public class CSVFormat implements Serializable { * the input stream * @return a stream of CSVRecord * @throws IOException + * If an I/O error occurs */ public Iterable parse(final Reader in) throws IOException { return new CSVParser(in, this); @@ -599,7 +600,8 @@ public class CSVFormat implements Serializable { * @param in * the input stream * @return a CSVRecord stream - * @throws IOException + * @throws IOException + * If an I/O error occurs */ public Iterable parse(final Reader in) throws IOException { return this.build().parse(in); diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java index 966edd02..fbce822c 100644 --- a/src/main/java/org/apache/commons/csv/CSVParser.java +++ b/src/main/java/org/apache/commons/csv/CSVParser.java @@ -99,6 +99,8 @@ public class CSVParser implements Iterable { * a Reader containing "csv-formatted" input * @throws IllegalArgumentException * thrown if the parameters of the format are inconsistent + * @throws IOException + * If an I/O error occurs */ public CSVParser(final Reader input) throws IOException { this(input, CSVFormat.DEFAULT); @@ -113,6 +115,8 @@ public class CSVParser implements Iterable { * the CSVFormat used for CSV parsing * @throws IllegalArgumentException * thrown if the parameters of the format are inconsistent + * @throws IOException + * If an I/O error occurs */ public CSVParser(final Reader input, final CSVFormat format) throws IOException { this.lexer = new CSVLexer(format, new ExtendedBufferedReader(input)); @@ -128,6 +132,8 @@ public class CSVParser implements Iterable { * the CSVFormat used for CSV parsing * @throws IllegalArgumentException * thrown if the parameters of the format are inconsistent + * @throws IOException + * If an I/O error occurs */ public CSVParser(final String input, final CSVFormat format) throws IOException { this(new StringReader(input), format); diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/src/main/java/org/apache/commons/csv/CSVPrinter.java index 211b79d5..5e980516 100644 --- a/src/main/java/org/apache/commons/csv/CSVPrinter.java +++ b/src/main/java/org/apache/commons/csv/CSVPrinter.java @@ -80,6 +80,7 @@ public class CSVPrinter implements Flushable, Closeable { * Flushes the underlying stream. * * @throws IOException + * If an I/O error occurs */ public void flush() throws IOException { if (out instanceof Flushable) {