CSVParser.parse(*) methods with a null Charset maps to

garydgregory · garydgregory · commit d93c4940f267 · 2025-03-14T16:29:53.000-04:00
Charset.defaultCharset()

Javadoc
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -49,6 +49,7 @@
       <action type="fix" dev="ggregory" due-to="Gary Gregory">CSVParser.parse(File, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)).</action>
       <action type="fix" dev="ggregory" due-to="Gary Gregory">CSVParser.parse(Path, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)).</action>
       <action type="fix" dev="ggregory" due-to="Gary Gregory">CSVParser.parse(InputStream, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)).</action>
+      <action type="fix" dev="ggregory" due-to="Gary Gregory">CSVParser.parse(*) methods with a null Charset maps to Charset.defaultCharset().</action>
       <!-- ADD -->
       <action type="add" dev="ggregory" due-to="Gary Gregory">Define and use Maven property commons.jmh.version.</action> 
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add CSVFormat.Builder.setMaxRows(long).</action> 
diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java
@@ -49,6 +49,7 @@
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
+import org.apache.commons.io.Charsets;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 import org.apache.commons.io.function.Uncheck;
 
@@ -305,15 +306,16 @@ public static Builder builder() {
      * @param file
      *            a CSV file. Must not be null.
      * @param charset
-     *            The Charset to decode the given file.
+     *            The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.
      * @param format
      *            the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.
      * @return a new parser
      * @throws IllegalArgumentException
-     *             If the parameters of the format are inconsistent or if either file or format are null.
+     *             If the parameters of the format are inconsistent.
      * @throws IOException
      *             If an I/O error occurs
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
+     * @throws NullPointerException if {@code file} is {@code null}.
      */
     public static CSVParser parse(final File file, final Charset charset, final CSVFormat format) throws IOException {
         Objects.requireNonNull(file, "file");
@@ -331,20 +333,20 @@ public static CSVParser parse(final File file, final Charset charset, final CSVF
      * @param inputStream
      *            an InputStream containing CSV-formatted input, {@code null} maps to {@link CSVFormat#DEFAULT}.
      * @param charset
-     *            The Charset to decode the given file.
+     *            The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.
      * @param format
      *            the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.
      * @return a new CSVParser configured with the given reader and format.
      * @throws IllegalArgumentException
      *             If the parameters of the format are inconsistent or if either reader or format are null.
      * @throws IOException
      *             If there is a problem reading the header or skipping the first record
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
      * @since 1.5
      */
     public static CSVParser parse(final InputStream inputStream, final Charset charset, final CSVFormat format)
             throws IOException {
-        return parse(new InputStreamReader(inputStream, charset), format);
+        return parse(new InputStreamReader(inputStream, Charsets.toCharset(charset)), format);
     }
 
     /**
@@ -353,15 +355,16 @@ public static CSVParser parse(final InputStream inputStream, final Charset chars
      * @param path
      *            a CSV file. Must not be null.
      * @param charset
-     *            The Charset to decode the given file.
+     *            The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.
      * @param format
      *            the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.
      * @return a new parser
      * @throws IllegalArgumentException
-     *             If the parameters of the format are inconsistent or if either file or format are null.
+     *             If the parameters of the format are inconsistent.
      * @throws IOException
      *             If an I/O error occurs
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
+     * @throws NullPointerException if {@code path} is {@code null}.
      * @since 1.5
      */
     @SuppressWarnings("resource")
@@ -387,7 +390,7 @@ public static CSVParser parse(final Path path, final Charset charset, final CSVF
      *             If the parameters of the format are inconsistent or if either reader or format are null.
      * @throws IOException
      *             If there is a problem reading the header or skipping the first record
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
      * @since 1.5
      */
     public static CSVParser parse(final Reader reader, final CSVFormat format) throws IOException {
@@ -403,10 +406,11 @@ public static CSVParser parse(final Reader reader, final CSVFormat format) throw
      *            the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.
      * @return a new parser
      * @throws IllegalArgumentException
-     *             If the parameters of the format are inconsistent or if either string or format are null.
+     *             If the parameters of the format are inconsistent.
      * @throws IOException
      *             If an I/O error occurs
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
+     * @throws NullPointerException if {@code string} is {@code null}.
      */
     public static CSVParser parse(final String string, final CSVFormat format) throws IOException {
         Objects.requireNonNull(string, "string");
@@ -424,15 +428,16 @@ public static CSVParser parse(final String string, final CSVFormat format) throw
      * @param url
      *            a URL. Must not be null.
      * @param charset
-     *            the charset for the resource. Must not be null.
+     *            the charset for the resource, {@code null} maps to the {@link Charset#defaultCharset() default Charset}.
      * @param format
      *            the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}.
      * @return a new parser
      * @throws IllegalArgumentException
-     *             If the parameters of the format are inconsistent or if either url, charset or format are null.
+     *             If the parameters of the format are inconsistent.
      * @throws IOException
      *             If an I/O error occurs
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
+     * @throws NullPointerException if {@code url} is {@code null}.
      */
     @SuppressWarnings("resource")
     public static CSVParser parse(final URL url, final Charset charset, final CSVFormat format) throws IOException {
@@ -484,7 +489,7 @@ public static CSVParser parse(final URL url, final Charset charset, final CSVFor
      *             If the parameters of the format are inconsistent or if either reader or format are null.
      * @throws IOException
      *             If there is a problem reading the header or skipping the first record
-     * @throws CSVException Thrown on invalid input.
+     * @throws CSVException Thrown on invalid CSV input data.
      * @deprecated Will be removed in the next major version, use {@link Builder#get()}.
      */
     @Deprecated
@@ -517,10 +522,9 @@ public CSVParser(final Reader reader, final CSVFormat format) throws IOException
      * @deprecated Will be private in the next major version, use {@link Builder#get()}.
      */
     @Deprecated
-    public CSVParser(final Reader reader, final CSVFormat format, final long characterOffset, final long recordNumber)
-        throws IOException {
-            this(reader, format, characterOffset, recordNumber, null, false);
-        }
+    public CSVParser(final Reader reader, final CSVFormat format, final long characterOffset, final long recordNumber) throws IOException {
+        this(reader, format, characterOffset, recordNumber, null, false);
+    }
 
     /**
      * Constructs a new instance using the given {@link CSVFormat}
@@ -546,7 +550,7 @@ public CSVParser(final Reader reader, final CSVFormat format, final long charact
      *             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.
+     * @throws CSVException Thrown on invalid CSV input data.
      */
     private CSVParser(final Reader reader, final CSVFormat format, final long characterOffset, final long recordNumber,
         final Charset charset, final boolean trackBytes)
@@ -875,7 +879,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 on invalid input.
+     * @throws CSVException on invalid CSV input data.
      */
     CSVRecord nextRecord() throws IOException {
         CSVRecord result = null;
diff --git a/src/test/java/org/apache/commons/csv/CSVParserTest.java b/src/test/java/org/apache/commons/csv/CSVParserTest.java
@@ -1358,8 +1358,7 @@ public void testNotValueCSV() throws IOException {
 
     @Test
     public void testParse() throws Exception {
-        final ClassLoader loader = ClassLoader.getSystemClassLoader();
-        final URL url = loader.getResource("org/apache/commons/csv/CSVFileParser/test.csv");
+        final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/test.csv");
         final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader("A", "B", "C", "D").get();
         final Charset charset = StandardCharsets.UTF_8;
         // Reader
@@ -1472,8 +1471,12 @@ public void testParsePathCharsetNullFormat() throws IOException {
     }
 
     @Test
-    public void testParserUrlNullCharsetFormat() {
-        assertThrows(NullPointerException.class, () -> CSVParser.parse(new URL("https://commons.apache.org"), null, CSVFormat.DEFAULT));
+    public void testParserUrlNullCharsetFormat() throws IOException {
+        final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/test.csv");
+        try (CSVParser parser = CSVParser.parse(url, null, CSVFormat.DEFAULT)) {
+            // null maps to DEFAULT.
+            parseFully(parser);
+        }
     }
 
     @Test
@@ -1492,8 +1495,7 @@ public void testParseStringNullFormat() throws IOException {
 
     @Test
     public void testParseUrlCharsetNullFormat() throws IOException {
-        final ClassLoader loader = ClassLoader.getSystemClassLoader();
-        final URL url = loader.getResource("org/apache/commons/csv/CSVFileParser/test.csv");
+        final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/test.csv");
         try (CSVParser parser = CSVParser.parse(url, Charset.defaultCharset(), null)) {
             // null maps to DEFAULT.
             parseFully(parser);
