[commons-csv] branch master updated: Add @SuppressWarnings and Javadoc.

[gg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git


The following commit(s) were added to refs/heads/master by this push:
     new 1963ea3  Add @SuppressWarnings and Javadoc.
1963ea3 is described below

commit 1963ea32d2b8f94211eace30708a2e4b80d4574c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun May 24 16:06:51 2020 -0400

    Add @SuppressWarnings and Javadoc.
---
 src/main/java/org/apache/commons/csv/CSVParser.java | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java
index 727bb5a..07aba51 100644
--- a/src/main/java/org/apache/commons/csv/CSVParser.java
+++ b/src/main/java/org/apache/commons/csv/CSVParser.java
@@ -236,7 +236,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable {
     }
 
     /**
-     * Creates a parser for the given {@link Path}.
+     * Creates and returns a parser for the given {@link Path}, which the caller MUST close.
      *
      * @param path
      *            a CSV file. Must not be null.
@@ -251,6 +251,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable {
      *             If an I/O error occurs
      * @since 1.5
      */
+    @SuppressWarnings("resource")
     public static CSVParser parse(final Path path, final Charset charset, final CSVFormat format) throws IOException {
         Objects.requireNonNull(path, "path");
         Objects.requireNonNull(format, "format");
@@ -303,7 +304,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable {
     // the following objects are shared to reduce garbage
 
     /**
-     * Creates a parser for the given URL.
+     * Creates and returns a parser for the given URL, which the caller MUST close.
      *
      * <p>
      * If you do not read all records from the given {@code url}, you should call {@link #close()} on the parser, unless
@@ -322,6 +323,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable {
      * @throws IOException
      *             If an I/O error occurs
      */
+    @SuppressWarnings("resource")
     public static CSVParser parse(final URL url, final Charset charset, final CSVFormat format) throws IOException {
         Objects.requireNonNull(url, "url");
         Objects.requireNonNull(charset, "charset");