[commons-io] branch master updated: Document using a try-with-resources, remove reference to deprecated method.

[ggregory]

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-io.git


The following commit(s) were added to refs/heads/master by this push:
     new b1d167f  Document using a try-with-resources, remove reference to 
deprecated method.
b1d167f is described below

commit b1d167fc5bfc7d1eb5f090b50b7585d8e644df6d
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Fri Jul 30 15:20:04 2021 -0400

    Document using a try-with-resources, remove reference to deprecated
    method.
---
 src/main/java/org/apache/commons/io/FileUtils.java |  5 ++---
 src/main/java/org/apache/commons/io/IOUtils.java   | 12 ++++++------
 2 files changed, 8 insertions(+), 9 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/FileUtils.java 
b/src/main/java/org/apache/commons/io/FileUtils.java
index ea24741..263f65b 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -2023,9 +2023,8 @@ public class FileUtils {
      * <p>
      * This method opens an {@code InputStream} for the file.
      * When you have finished with the iterator you should close the stream
-     * to free internal resources. This can be done by calling the
-     * {@link LineIterator#close()} or
-     * {@link LineIterator#closeQuietly(LineIterator)} method.
+     * to free internal resources. This can be done by using a 
try-with-resources block or calling the
+     * {@link LineIterator#close()} method.
      * </p>
      * <p>
      * The recommended usage pattern is:
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java 
b/src/main/java/org/apache/commons/io/IOUtils.java
index e41225a..aecbc46 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -1574,8 +1574,8 @@ public class IOUtils {
      * {@code LineIterator} holds a reference to the open
      * {@code InputStream} specified here. When you have finished with
      * the iterator you should close the stream to free internal resources.
-     * This can be done by closing the stream directly, or by calling
-     * {@link LineIterator#close()} or {@link 
LineIterator#closeQuietly(LineIterator)}.
+     * This can be done by using a try-with-resources block, closing the 
stream directly, or by calling
+     * {@link LineIterator#close()}.
      * <p>
      * The recommended usage pattern is:
      * <pre>
@@ -1607,8 +1607,8 @@ public class IOUtils {
      * {@code LineIterator} holds a reference to the open
      * {@code InputStream} specified here. When you have finished with
      * the iterator you should close the stream to free internal resources.
-     * This can be done by closing the stream directly, or by calling
-     * {@link LineIterator#close()} or {@link 
LineIterator#closeQuietly(LineIterator)}.
+     * This can be done by using a try-with-resources block, closing the 
stream directly, or by calling
+     * {@link LineIterator#close()}.
      * <p>
      * The recommended usage pattern is:
      * <pre>
@@ -1642,8 +1642,8 @@ public class IOUtils {
      * {@code LineIterator} holds a reference to the open
      * {@code Reader} specified here. When you have finished with the
      * iterator you should close the reader to free internal resources.
-     * This can be done by closing the reader directly, or by calling
-     * {@link LineIterator#close()} or {@link 
LineIterator#closeQuietly(LineIterator)}.
+     * This can be done by using a try-with-resources block, closing the 
reader directly, or by calling
+     * {@link LineIterator#close()}.
      * <p>
      * The recommended usage pattern is:
      * <pre>