CSVParser.nextRecord() should throw CSVException (an IOException

subclass) instead of IOException and IllegalStateException, no method
signature changes needed

Author: garydgregory

src/changes/changes.xml

@@ -43,6 +43,7 @@
     <release version="1.13.0" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
       <!-- FIX -->
       <action type="fix" issue="CSV-314" dev="ggregory" due-to="Gary Gregory">Required OSGi Import-Package version numbers in MANIFEST.MF #504.</action>
+      <action type="fix" issue="CSV-314" dev="ggregory" due-to="Gary Gregory">CSVParser.nextRecord() should throw CSVException (an IOException subclass) instead of IOException and IllegalStateException, no method signature changes needed.</action>
       <!-- ADD -->
       <action type="add" issue="CSV-313" dev="ggregory" due-to="Gary Gregory">Add CSVPrinter.getRecordCount().</action>
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add and use CSVParser.Builder and builder() and deprecate CSVParser constructors.</action>

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

@@ -208,6 +208,8 @@ final class CSVRecordIterator implements Iterator<CSVRecord> {
         /**
          * Gets the next record.
          *
+         * @throws IOException  on parse error or input read-failure
+         * @throws CSVException on invalid input.
          * @return the next record.
          */
         private CSVRecord getNextRecord() {
@@ -498,8 +500,8 @@ public CSVParser(final Reader reader, final CSVFormat format) throws IOException
      * @throws IllegalArgumentException
      *             If the parameters of the format are inconsistent or if either the reader or format is null.
      * @throws IOException
-     *             If there is a problem reading the header or skipping the first record
-     * @throws CSVException Thrown on invalid input.
+     *             if there is a problem reading the header or skipping the first record
+     * @throws CSVException on invalid input.
      * @since 1.1
      * @deprecated Will be private in the next major version, use {@link Builder#get()}.
      */
@@ -547,7 +549,7 @@ private Map<String, Integer> createEmptyHeaderMap() {
      *
      * @return null if the format has no header.
      * @throws IOException if there is a problem reading the header or skipping the first record
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException on invalid input.
      */
     private Headers createHeaders() throws IOException {
         Map<String, Integer> hdrMap = null;
@@ -830,7 +832,7 @@ public Iterator<CSVRecord> iterator() {
      *
      * @return the record as an array of values, or {@code null} if the end of the stream has been reached
      * @throws IOException  on parse error or input read-failure
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException on invalid input.
      */
     CSVRecord nextRecord() throws IOException {
         CSVRecord result = null;
@@ -855,7 +857,7 @@ CSVRecord nextRecord() throws IOException {
                 }
                 break;
             case INVALID:
-                throw new IOException("(line " + getCurrentLineNumber() + ") invalid parse sequence");
+                throw new CSVException("(line %,d) invalid parse sequence", getCurrentLineNumber());
             case COMMENT: // Ignored currently
                 if (sb == null) { // first comment for this record
                     sb = new StringBuilder();
@@ -866,7 +868,7 @@ CSVRecord nextRecord() throws IOException {
                 reusableToken.type = TOKEN; // Read another token
                 break;
             default:
-                throw new IllegalStateException("Unexpected Token type: " + reusableToken.type);
+                throw new CSVException("Unexpected Token type: %s", reusableToken.type);
             }
         } while (reusableToken.type == TOKEN);