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 6cad188 Javadoc.
6cad188 is described below
commit 6cad188fba5f5af4027f262a1d704e74fac0ca7c
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Thu Jan 28 19:19:56 2021 -0500
Javadoc.
---
src/main/java/org/apache/commons/io/FilenameUtils.java | 3 +--
src/main/java/org/apache/commons/io/IOUtils.java | 12 ++++++------
src/main/java/org/apache/commons/io/input/BoundedReader.java | 2 +-
3 files changed, 8 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java
b/src/main/java/org/apache/commons/io/FilenameUtils.java
index fccf46d..bd57e4e 100644
--- a/src/main/java/org/apache/commons/io/FilenameUtils.java
+++ b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -531,8 +531,7 @@ public class FilenameUtils {
* @param canonicalChild
* the file to consider as the child.
* @return true is the candidate leaf is under by the specified composite.
False otherwise.
- * @throws IOException
- * if an IO error occurs while checking the files.
+ * @throws IOException Never thrown.
* @since 2.2
* @see FileUtils#directoryContains(File, File)
*/
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index d5736cf..cec444d 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -1480,7 +1480,7 @@ public class IOUtils {
* @param charset the charset to use, null means platform default
* @return an Iterator of the lines in the reader, never null
* @throws IllegalArgumentException if the input is null
- * @throws IOException not actually thrown
+ * @throws IOException Never thrown.
* @since 2.3
*/
public static LineIterator lineIterator(final InputStream input, final
Charset charset) throws IOException {
@@ -2430,7 +2430,7 @@ public class IOUtils {
* @param input the {@code String} to convert
* @return the requested byte array
* @throws NullPointerException if the input is null
- * @throws IOException not actually thrown
+ * @throws IOException Never thrown.
* @deprecated 2.5 Use {@link String#getBytes()} instead
*/
@Deprecated
@@ -2604,7 +2604,7 @@ public class IOUtils {
* @param input the CharSequence to convert
* @param charsetName the name of the requested charset, null means
platform default
* @return an input stream
- * @throws IOException not actually thrown
+ * @throws IOException Never thrown.
* @throws java.nio.charset.UnsupportedCharsetException thrown instead of
{@link java.io
*
.UnsupportedEncodingException} in version 2.2 if the
* encoding is not
supported.
@@ -2651,7 +2651,7 @@ public class IOUtils {
* @param input the string to convert
* @param charsetName the name of the requested charset, null means
platform default
* @return an input stream
- * @throws IOException not actually thrown
+ * @throws IOException Never thrown.
* @throws java.nio.charset.UnsupportedCharsetException thrown instead of
{@link java.io
*
.UnsupportedEncodingException} in version 2.2 if the
* encoding is not
supported.
@@ -2669,7 +2669,7 @@ public class IOUtils {
* @param input the byte array to read from
* @return the requested String
* @throws NullPointerException if the input is null
- * @throws IOException not actually thrown
+ * @throws IOException Never thrown.
* @deprecated 2.5 Use {@link String#String(byte[])} instead
*/
@Deprecated
@@ -2689,7 +2689,7 @@ public class IOUtils {
* @param charsetName the name of the requested charset, null means
platform default
* @return the requested String
* @throws NullPointerException if the input is null
- * @throws IOException not actually thrown
+ * @throws IOException Never thrown.
*/
public static String toString(final byte[] input, final String
charsetName) throws IOException {
return new String(input, Charsets.toCharset(charsetName));
diff --git a/src/main/java/org/apache/commons/io/input/BoundedReader.java
b/src/main/java/org/apache/commons/io/input/BoundedReader.java
index 8bb6845..799bc34 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedReader.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedReader.java
@@ -51,7 +51,7 @@ public class BoundedReader extends Reader {
*
* @param target The target stream that will be used
* @param maxCharsFromTargetReader The maximum number of characters that
can be read from target
- * @throws IOException never thrown
+ * @throws IOException Never thrown.
*/
public BoundedReader(final Reader target, final int
maxCharsFromTargetReader) throws IOException {
this.target = target;
