Skip to content

Commit 6cad188

Browse files
author
Gary Gregory
committed
Javadoc.
1 parent 6d83117 commit 6cad188

3 files changed

Lines changed: 8 additions & 9 deletions

File tree

src/main/java/org/apache/commons/io/FilenameUtils.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -531,8 +531,7 @@ public static String concat(final String basePath, final String fullFileNameToAd
531531
* @param canonicalChild
532532
* the file to consider as the child.
533533
* @return true is the candidate leaf is under by the specified composite. False otherwise.
534-
* @throws IOException
535-
* if an IO error occurs while checking the files.
534+
* @throws IOException Never thrown.
536535
* @since 2.2
537536
* @see FileUtils#directoryContains(File, File)
538537
*/

src/main/java/org/apache/commons/io/IOUtils.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1480,7 +1480,7 @@ public static int length(final Object[] array) {
14801480
* @param charset the charset to use, null means platform default
14811481
* @return an Iterator of the lines in the reader, never null
14821482
* @throws IllegalArgumentException if the input is null
1483-
* @throws IOException not actually thrown
1483+
* @throws IOException Never thrown.
14841484
* @since 2.3
14851485
*/
14861486
public static LineIterator lineIterator(final InputStream input, final Charset charset) throws IOException {
@@ -2430,7 +2430,7 @@ public static byte[] toByteArray(final Reader reader, final String charsetName)
24302430
* @param input the {@code String} to convert
24312431
* @return the requested byte array
24322432
* @throws NullPointerException if the input is null
2433-
* @throws IOException not actually thrown
2433+
* @throws IOException Never thrown.
24342434
* @deprecated 2.5 Use {@link String#getBytes()} instead
24352435
*/
24362436
@Deprecated
@@ -2604,7 +2604,7 @@ public static InputStream toInputStream(final CharSequence input, final Charset
26042604
* @param input the CharSequence to convert
26052605
* @param charsetName the name of the requested charset, null means platform default
26062606
* @return an input stream
2607-
* @throws IOException not actually thrown
2607+
* @throws IOException Never thrown.
26082608
* @throws java.nio.charset.UnsupportedCharsetException thrown instead of {@link java.io
26092609
* .UnsupportedEncodingException} in version 2.2 if the
26102610
* encoding is not supported.
@@ -2651,7 +2651,7 @@ public static InputStream toInputStream(final String input, final Charset charse
26512651
* @param input the string to convert
26522652
* @param charsetName the name of the requested charset, null means platform default
26532653
* @return an input stream
2654-
* @throws IOException not actually thrown
2654+
* @throws IOException Never thrown.
26552655
* @throws java.nio.charset.UnsupportedCharsetException thrown instead of {@link java.io
26562656
* .UnsupportedEncodingException} in version 2.2 if the
26572657
* encoding is not supported.
@@ -2669,7 +2669,7 @@ public static InputStream toInputStream(final String input, final String charset
26692669
* @param input the byte array to read from
26702670
* @return the requested String
26712671
* @throws NullPointerException if the input is null
2672-
* @throws IOException not actually thrown
2672+
* @throws IOException Never thrown.
26732673
* @deprecated 2.5 Use {@link String#String(byte[])} instead
26742674
*/
26752675
@Deprecated
@@ -2689,7 +2689,7 @@ public static String toString(final byte[] input) throws IOException {
26892689
* @param charsetName the name of the requested charset, null means platform default
26902690
* @return the requested String
26912691
* @throws NullPointerException if the input is null
2692-
* @throws IOException not actually thrown
2692+
* @throws IOException Never thrown.
26932693
*/
26942694
public static String toString(final byte[] input, final String charsetName) throws IOException {
26952695
return new String(input, Charsets.toCharset(charsetName));

src/main/java/org/apache/commons/io/input/BoundedReader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public class BoundedReader extends Reader {
5151
*
5252
* @param target The target stream that will be used
5353
* @param maxCharsFromTargetReader The maximum number of characters that can be read from target
54-
* @throws IOException never thrown
54+
* @throws IOException Never thrown.
5555
*/
5656
public BoundedReader(final Reader target, final int maxCharsFromTargetReader) throws IOException {
5757
this.target = target;

0 commit comments

Comments
 (0)