(commons-io) branch master updated: Javadoc
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 c9fd7fc57 Javadoc
c9fd7fc57 is described below
commit c9fd7fc573055093059b87618b1c0b9b758f0f86
Author: Gary Gregory
AuthorDate: Tue Jun 18 09:06:56 2024 -0400
Javadoc
---
src/main/java/org/apache/commons/io/CopyUtils.java| 2 +-
src/main/java/org/apache/commons/io/FileSystemUtils.java | 3 ++-
src/main/java/org/apache/commons/io/FileUtils.java| 2 +-
src/main/java/org/apache/commons/io/FilenameUtils.java| 4 ++--
src/main/java/org/apache/commons/io/IOCase.java | 3 ++-
src/main/java/org/apache/commons/io/IOUtils.java | 10 ++
src/main/java/org/apache/commons/io/file/PathUtils.java | 8
.../java/org/apache/commons/io/filefilter/AndFileFilter.java | 3 ++-
.../java/org/apache/commons/io/filefilter/IOFileFilter.java | 4 ++--
.../java/org/apache/commons/io/filefilter/OrFileFilter.java | 3 ++-
src/main/java/org/apache/commons/io/input/BoundedReader.java | 2 +-
.../commons/io/input/BufferedFileChannelInputStream.java | 3 ++-
.../org/apache/commons/io/input/MarkShieldInputStream.java| 3 ++-
.../java/org/apache/commons/io/input/QueueInputStream.java| 2 +-
.../java/org/apache/commons/io/input/ReaderInputStream.java | 11 +++
.../commons/io/input/UnsynchronizedByteArrayInputStream.java | 2 +-
.../commons/io/input/buffer/CircularBufferInputStream.java| 3 ++-
.../org/apache/commons/io/output/AppendableOutputStream.java | 3 ++-
.../org/apache/commons/io/output/FileWriterWithEncoding.java | 2 +-
.../java/org/apache/commons/io/output/LockableFileWriter.java | 5 +++--
.../java/org/apache/commons/io/output/QueueOutputStream.java | 2 +-
.../org/apache/commons/io/output/StringBuilderWriter.java | 5 +++--
.../java/org/apache/commons/io/output/WriterOutputStream.java | 11 +++
23 files changed, 57 insertions(+), 39 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/CopyUtils.java
b/src/main/java/org/apache/commons/io/CopyUtils.java
index ad562aa67..72da100a5 100644
--- a/src/main/java/org/apache/commons/io/CopyUtils.java
+++ b/src/main/java/org/apache/commons/io/CopyUtils.java
@@ -68,7 +68,7 @@ import java.nio.charset.Charset;
* Imagine that an InputStream's read() is a very expensive operation, which
* would usually suggest wrapping in a BufferedInputStream. The
* BufferedInputStream works by issuing infrequent
- * {@link java.io.InputStream#read(byte[] b, int off, int len)} requests on the
+ * {@link InputStream#read(byte[] b, int off, int len)} requests on the
* underlying InputStream, to fill an internal buffer, from which further
* {@code read} requests can inexpensively get their data (until the buffer
* runs out).
diff --git a/src/main/java/org/apache/commons/io/FileSystemUtils.java
b/src/main/java/org/apache/commons/io/FileSystemUtils.java
index c32142ba7..cfa10205b 100644
--- a/src/main/java/org/apache/commons/io/FileSystemUtils.java
+++ b/src/main/java/org/apache/commons/io/FileSystemUtils.java
@@ -16,6 +16,7 @@
*/
package org.apache.commons.io;
+import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
@@ -25,7 +26,7 @@ import java.util.Objects;
/**
* General File System utilities.
*
- * This class provides static utility methods for general file system
functions not provided before Java 6's {@link java.io.File File} class.
+ * This class provides static utility methods for general file system
functions not provided before Java 6's {@link File File} class.
*
*
* The current functions provided are:
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index 779f07812..aac463675 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1513,7 +1513,7 @@ public class FileUtils {
* WARNING: this method relies on the Java system property 'java.io.tmpdir'
* which may or may not have a trailing file separator.
* This can affect code that uses String processing to manipulate
pathnames rather
- * than the standard libary methods in classes such as {@link java.io.File}
+ * than the standard libary methods in classes such as {@link File}
*
* @return the path to the system temporary directory as a String
* @since 2.0
diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java
b/src/main/java/org/apache/commons/io/FilenameUtils.java
index b8c92f15e..508f2da90 100644
--- a/src/main/java/org/apache/commons/io/FilenameUtils.java
+++ b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -38,8 +38,8 @@ import
(commons-io) branch master updated: Javadoc
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 99357c726 Javadoc
new b0b49492e Merge branch 'master' of
https://gitbox.apache.org/repos/asf/commons-io.git
99357c726 is described below
commit 99357c726c1efbe03b27c9019a0442c4dafc8637
Author: Gary Gregory
AuthorDate: Tue Jun 11 16:08:49 2024 -0400
Javadoc
---
.../java/org/apache/commons/io/input/ChecksumInputStream.java | 10 ++
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
index e56ba6670..d530edb96 100644
--- a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
@@ -48,7 +48,8 @@ public final class ChecksumInputStream extends
CountingInputStream {
* Builds a new {@link ChecksumInputStream}.
*
*
- * There is no default {@link Checksum}; you MUST provide one.
+ * There is no default {@link Checksum}; you MUST provide one. This avoids
any issue with a default {@link Checksum} being proven deficient or insecure
+ * in the future.
*
* Using NIO
* {@code
@@ -99,8 +100,8 @@ public final class ChecksumInputStream extends
CountingInputStream {
public static class Builder extends
AbstractStreamBuilder {
/**
- * There is no default checksum, you MUST provide one. This avoids any
issue with a default {@link Checksum}
- * being proven deficient or insecure in the future.
+ * There is no default {@link Checksum}, you MUST provide one. This
avoids any issue with a default {@link Checksum} being proven deficient or
insecure
+ * in the future.
*/
private Checksum checksum;
@@ -146,7 +147,8 @@ public final class ChecksumInputStream extends
CountingInputStream {
}
/**
- * Sets the Checksum.
+ * Sets the Checksum. There is no default {@link Checksum}, you MUST
provide one. This avoids any issue with a default {@link Checksum} being proven
+ * deficient or insecure in the future.
*
* @param checksum the Checksum.
* @return {@code this} instance.
(commons-io) branch master updated: Javadoc
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 9fe52e181 Javadoc
9fe52e181 is described below
commit 9fe52e18131a05bc431c47b05b8ca5624b381bd0
Author: Gary Gregory
AuthorDate: Thu Jun 6 10:04:39 2024 -0400
Javadoc
---
src/main/java/org/apache/commons/io/file/PathUtils.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java
b/src/main/java/org/apache/commons/io/file/PathUtils.java
index 857db4be4..46bc87cad 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -875,7 +875,7 @@ public final class PathUtils {
}
/**
- * Shorthand for {@code Files.getFileAttributeView(path,
DosFileAttributeView.class)}.
+ * Shorthand for {@code Files.getFileAttributeView(path,
DosFileAttributeView.class, options)}.
*
* @param paththe path to the file.
* @param options how to handle symbolic links.
(commons-io) branch master updated: Javadoc
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 618c806db Javadoc
618c806db is described below
commit 618c806dbf8bd2193734f864077e221bb7094cac
Author: Gary Gregory
AuthorDate: Thu May 23 09:21:12 2024 -0400
Javadoc
---
.../commons/io/build/AbstractOriginSupplier.java | 24 +++---
.../commons/io/build/AbstractStreamBuilder.java| 2 +-
.../commons/io/filefilter/WildcardFileFilter.java | 6 +++---
.../apache/commons/io/input/BOMInputStream.java| 4 ++--
.../commons/io/input/CharSequenceInputStream.java | 2 +-
.../commons/io/input/MessageDigestInputStream.java | 4 ++--
.../apache/commons/io/input/QueueInputStream.java | 2 +-
.../io/input/RandomAccessFileInputStream.java | 4 ++--
.../commons/io/input/ReadAheadInputStream.java | 2 +-
.../apache/commons/io/input/ReaderInputStream.java | 2 +-
.../java/org/apache/commons/io/input/Tailer.java | 12 +--
.../io/output/DeferredFileOutputStream.java| 14 ++---
.../commons/io/output/FileWriterWithEncoding.java | 4 ++--
.../commons/io/output/LockableFileWriter.java | 6 +++---
.../commons/io/output/WriterOutputStream.java | 4 ++--
15 files changed, 46 insertions(+), 46 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
index bd8237132..bd62682a4 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
@@ -196,7 +196,7 @@ public abstract class AbstractOriginSupplier origin) {
this.origin = origin;
@@ -258,7 +258,7 @@ public abstract class AbstractOriginSupplier wildcards) {
setWildcards(requireWildcards(wildcards).toArray(EMPTY_STRING_ARRAY));
@@ -129,7 +129,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
* Sets the wildcards to match, not null.
*
* @param wildcards the wildcards to match, not null.
- * @return this
+ * @return {@code this} instance.
*/
public Builder setWildcards(final String... wildcards) {
this.wildcards = requireWildcards(wildcards);
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 130c7a4a1..bf1e43226 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -178,7 +178,7 @@ public class BOMInputStream extends ProxyInputStream {
*
*
* @param byteOrderMarks the ByteOrderMarks to detect and optionally
exclude.
- * @return this
+ * @return {@code this} instance.
*/
public Builder setByteOrderMarks(final ByteOrderMark...
byteOrderMarks) {
this.byteOrderMarks = byteOrderMarks != null ?
byteOrderMarks.clone() : DEFAULT;
@@ -192,7 +192,7 @@ public class BOMInputStream extends ProxyInputStream {
*
*
* @param include true to include the UTF-8 BOM or false to exclude
it. return this;
- * @return this
+ * @return {@code this} instance.
*/
public Builder setInclude(final boolean include) {
this.include = include;
diff --git
a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index 2f25d1465..c36d0d616 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -122,7 +122,7 @@ public class CharSequenceInputStream extends InputStream {
* Sets the charset encoder. Assumes that the caller has configured
the encoder.
*
* @param newEncoder the charset encoder.
- * @return this
+ * @return {@code this} instance.
* @since 2.13.0
*/
public Builder setCharsetEncoder(final CharsetEncoder newEncoder) {
diff --git
a/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
b/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
index d789dc411..01b03996f 100644
--- a/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
@@ -110,7 +110,7 @@ public final class MessageDigestInputStream extends
ObservableInputStream {
*
*
* @param messageDigest the message digest.
- * @return this
+ * @return {@code this} instance.
*/
(commons-io) branch master updated: Javadoc
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 573b9e0d9 Javadoc
573b9e0d9 is described below
commit 573b9e0d990626f11a481d5dacfac83d489cccfc
Author: Gary Gregory
AuthorDate: Thu May 23 09:17:53 2024 -0400
Javadoc
---
.../apache/commons/io/build/AbstractStreamBuilder.java | 16
.../org/apache/commons/io/input/BoundedInputStream.java | 6 +++---
.../org/apache/commons/io/input/ChecksumInputStream.java | 6 +++---
.../org/apache/commons/io/input/QueueInputStream.java| 2 +-
src/main/java/org/apache/commons/io/input/Tailer.java| 2 +-
.../io/input/UnsynchronizedByteArrayInputStream.java | 4 ++--
.../org/apache/commons/io/input/XmlStreamReader.java | 4 ++--
7 files changed, 20 insertions(+), 20 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
index 519c2cf08..c8c9fbdea 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
@@ -230,7 +230,7 @@ public abstract class AbstractStreamBuilder
*
* @param bufferSize the buffer size.
- * @return this.
+ * @return {@code this} instance.
*/
public B setBufferSize(final int bufferSize) {
this.bufferSize = checkBufferSize(bufferSize > 0 ? bufferSize :
bufferSizeDefault);
@@ -244,7 +244,7 @@ public abstract class AbstractStreamBuilder
*
* @param bufferSize the buffer size, null resets to the default.
- * @return this.
+ * @return {@code this} instance.
*/
public B setBufferSize(final Integer bufferSize) {
setBufferSize(bufferSize != null ? bufferSize : bufferSizeDefault);
@@ -270,7 +270,7 @@ public abstract class AbstractStreamBuilder
*
* @param bufferSizeDefault the buffer size, null resets to the default.
- * @return this.
+ * @return {@code this} instance.
*/
protected B setBufferSizeDefault(final int bufferSizeDefault) {
this.bufferSizeDefault = bufferSizeDefault;
@@ -282,7 +282,7 @@ public abstract class AbstractStreamBuilder
*
* @param charset the Charset, null resets to the default.
- * @return this.
+ * @return {@code this} instance.
*/
public B setCharset(final Charset charset) {
this.charset = Charsets.toCharset(charset, charsetDefault);
@@ -311,7 +311,7 @@ public abstract class AbstractStreamBuilder
*
* @param charset the Charset name, null resets to the default.
- * @return this.
+ * @return {@code this} instance.
*/
public B setCharset(final String charset) {
return setCharset(Charsets.toCharset(charset, charsetDefault));
@@ -324,7 +324,7 @@ public abstract class AbstractStreamBuilder
*
* @param defaultCharset the Charset name, null resets to the default.
- * @return this.
+ * @return {@code this} instance.
*/
protected B setCharsetDefault(final Charset defaultCharset) {
this.charsetDefault = defaultCharset;
@@ -341,7 +341,7 @@ public abstract class AbstractStreamBuilder
*
* @param openOptions the OpenOption[] name, null resets to the default.
- * @return this.
+ * @return {@code this} instance.
* @since 2.13.0
* @see #setInputStream(InputStream)
* @see #setOutputStream(OutputStream)
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
index 31767e40c..83431db3a 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -117,7 +117,7 @@ public class BoundedInputStream extends ProxyInputStream {
*
*
* @param count The current number of bytes counted.
- * @return this.
+ * @return {@code this} instance.
*/
public T setCount(final long count) {
this.count = Math.max(0, count);
@@ -131,7 +131,7 @@ public class BoundedInputStream extends ProxyInputStream {
*
*
* @param maxCount The maximum number of bytes to return.
- * @return this.
+ * @return {@code this} instance.
*/
public T setMaxCount(final long maxCount) {
this.maxCount = Math.max(EOF, maxCount);
@@ -146,7 +146,7 @@ public class BoundedInputStream extends ProxyInputStream {
*
* @param propagateClose {@code true} if calling {@link #close()}
propagates to the {@code close()} method of the underlying stream or {@code
false} if
* it does not.
- * @return this.
+
(commons-io) branch master updated: Javadoc (internal)
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 8c9d8d795 Javadoc (internal)
8c9d8d795 is described below
commit 8c9d8d7956730b1a9dad6a005155b869b4fb99d6
Author: Gary Gregory
AuthorDate: Wed Apr 3 10:44:37 2024 -0400
Javadoc (internal)
---
src/main/java/org/apache/commons/io/IOUtils.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index 7d7ee4c7d..63c7b3098 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -1686,7 +1686,7 @@ public class IOUtils {
/**
* Fills the given array with 0s.
*
- * @param arr The array to fill.
+ * @param arr The non-null array to fill.
* @return The given array.
*/
private static byte[] fill0(final byte[] arr) {
@@ -1697,7 +1697,7 @@ public class IOUtils {
/**
* Fills the given array with 0s.
*
- * @param arr The array to fill.
+ * @param arr The non-null array to fill.
* @return The given array.
*/
private static char[] fill0(final char[] arr) {
(commons-io) branch master updated: Javadoc
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 4e928266f Javadoc
4e928266f is described below
commit 4e928266f807fc4c567f7a83e9d9c500c3fcb384
Author: Gary Gregory
AuthorDate: Sat Mar 30 09:50:45 2024 -0400
Javadoc
---
.../java/org/apache/commons/io/FileSystemUtils.java | 20
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileSystemUtils.java
b/src/main/java/org/apache/commons/io/FileSystemUtils.java
index 091b333c7..c32142ba7 100644
--- a/src/main/java/org/apache/commons/io/FileSystemUtils.java
+++ b/src/main/java/org/apache/commons/io/FileSystemUtils.java
@@ -55,8 +55,7 @@ public class FileSystemUtils {
* @param path the path to get free space for, not null, not empty on UNIX
* @return the amount of free drive space on the drive or volume
* @throws IOException if an I/O error occurs.
- * @throws IllegalArgumentException if the path is invalid
- * @throws IllegalStateExceptionif an error occurred in initialization
+ * @throws IllegalArgumentException if the path is invalid.
* @since 1.1, enhanced OS support in 1.2 and 1.3
* @deprecated Use freeSpaceKb(String) Deprecated from 1.3, may be removed
in 2.0
*/
@@ -76,8 +75,8 @@ public class FileSystemUtils {
*
*
* @return the amount of free drive space on the drive or volume in
kilobytes
- * @throws IOException if an I/O error occurs.
- * @throws IllegalStateException if an error occurred in initialization
+ * @throws IOException if an I/O error occurs.
+ * @throws IllegalArgumentException if the path is invalid.
* @since 2.0
* @deprecated As of 2.6 deprecated without replacement. Please use {@link
java.nio.file.FileStore#getUsableSpace()}.
*/
@@ -98,8 +97,8 @@ public class FileSystemUtils {
*
* @param timeout ignored.
* @return the amount of free drive space on the drive or volume in
kilobytes
- * @throws IOException if an I/O error occurs.
- * @throws IllegalStateException if an error occurred in initialization
+ * @throws IOException if an I/O error occurs.
+ * @throws IllegalArgumentException if the path is invalid.
* @since 2.0
* @deprecated As of 2.6 deprecated without replacement. Please use {@link
java.nio.file.FileStore#getUsableSpace()}.
*/
@@ -119,8 +118,7 @@ public class FileSystemUtils {
* @param path the path to get free space for, not null, not empty on UNIX
* @return the amount of free drive space on the drive or volume in
kilobytes
* @throws IOException if an I/O error occurs.
- * @throws IllegalArgumentException if the path is invalid
- * @throws IllegalStateExceptionif an error occurred in initialization
+ * @throws IllegalArgumentException if the path is invalid.
* @since 1.2, enhanced OS support in 1.3
* @deprecated As of 2.6 deprecated without replacement. Please use {@link
java.nio.file.FileStore#getUsableSpace()}.
*/
@@ -141,8 +139,7 @@ public class FileSystemUtils {
* @param timeout ignored.
* @return the amount of free drive space on the drive or volume in
kilobytes
* @throws IOException if an I/O error occurs.
- * @throws IllegalArgumentException if the path is invalid
- * @throws IllegalStateExceptionif an error occurred in initialization
+ * @throws IllegalArgumentException if the path is invalid.
* @since 2.0
* @deprecated As of 2.6 deprecated without replacement. Please use {@link
java.nio.file.FileStore#getUsableSpace()}.
*/
@@ -162,8 +159,7 @@ public class FileSystemUtils {
* @param pathStr the path to get free space for, not null, not empty on
UNIX
* @return the amount of free drive space on the drive or volume
* @throws IOException if an I/O error occurs.
- * @throws IllegalArgumentException if the path is invalid
- * @throws IllegalStateExceptionif an error occurred in initialization
+ * @throws IllegalArgumentException if the path is invalid.
*/
static long getFreeSpace(final String pathStr) throws IOException {
final Path path = Paths.get(Objects.requireNonNull(pathStr,
"pathStr"));
(commons-io) branch master updated: Javadoc
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 e8c2774e0 Javadoc
e8c2774e0 is described below
commit e8c2774e0adb62e38899262b2a1ebc4fdefdcc3c
Author: Gary Gregory
AuthorDate: Sat Mar 23 15:58:59 2024 -0400
Javadoc
Remove some whitespace
---
.../org/apache/commons/io/output/DeferredFileOutputStream.java| 8
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
index bd69e0e58..38bd1fb48 100644
--- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
@@ -46,7 +46,6 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
// @formatter:off
/**
* Builds a new {@link DeferredFileOutputStream}.
- *
*
* For example:
*
@@ -374,9 +373,11 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
* Gets either the output File specified in the constructor or the
temporary File created or null.
*
* If the constructor specifying the File is used then it returns that
same output File, even when threshold has not been reached.
+ *
*
* If constructor specifying a temporary File prefix/suffix is used then
the temporary File created once the threshold is reached is returned if the
* threshold was not reached then {@code null} is returned.
+ *
*
* @return The File for this output stream, or {@code null} if no such
File exists.
*/
@@ -388,9 +389,11 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
* Gets either the output Path specified in the constructor or the
temporary Path created or null.
*
* If the constructor specifying the file is used then it returns that
same output Path, even when threshold has not been reached.
+ *
*
* If constructor specifying a temporary Path prefix/suffix is used then
the temporary Path created once the threshold is reached is returned if the
* threshold was not reached then {@code null} is returned.
+ *
*
* @return The Path for this output stream, or {@code null} if no such
Path exists.
* @since 2.14.0
@@ -403,7 +406,6 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
* Gets the current output stream. This may be memory based or disk based,
depending on the current state with respect to the threshold.
*
* @return The underlying output stream.
- *
* @throws IOException if an error occurs.
*/
@Override
@@ -461,7 +463,6 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
if (!closed) {
throw new IOException("Stream not closed");
}
-
if (isInMemory()) {
return memoryOutputStream.toInputStream();
}
@@ -482,7 +483,6 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
if (!closed) {
throw new IOException("Stream not closed");
}
-
if (isInMemory()) {
memoryOutputStream.writeTo(outputStream);
} else {
(commons-io) branch master updated: Javadoc
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 2c927dc1e Javadoc
2c927dc1e is described below
commit 2c927dc1eda4e7ab2a9f62a7ced02266cd02949f
Author: Gary Gregory
AuthorDate: Sun Feb 18 15:32:07 2024 -0500
Javadoc
---
src/main/java/org/apache/commons/io/input/ProxyInputStream.java | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index 0d05c9e66..c412d04fd 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -39,6 +39,9 @@ import org.apache.commons.io.IOUtils;
* notify a subclass that an exception was caught through {@link
#handleIOException(IOException)}
* {@link #unwrap()} itself
*
+ *
+ * This class does not add any state (no additional instance variables).
+ *
*/
public abstract class ProxyInputStream extends FilterInputStream {
(commons-io) branch master updated: Javadoc
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 d284ba45b Javadoc
d284ba45b is described below
commit d284ba45b19cc58d25a2bba5f37e382187b70647
Author: Gary Gregory
AuthorDate: Sun Feb 18 15:30:43 2024 -0500
Javadoc
---
.../apache/commons/io/input/ProxyInputStream.java | 22 --
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index 872c29144..0d05c9e66 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -25,18 +25,20 @@ import java.io.InputStream;
import org.apache.commons.io.IOUtils;
/**
- * A Proxy stream which acts as expected, that is it passes the method
- * calls on to the proxied stream and doesn't change which methods are
- * being called.
+ * A proxy stream which acts as a {@link FilterInputStream}, by passing all
method calls on to the proxied stream, not changing which methods are called.
*
- * It is an alternative base class to FilterInputStream
- * to increase reusability, because FilterInputStream changes the
- * methods being called, such as read(byte[]) to read(byte[], int, int).
+ * It is an alternative base class to {@link FilterInputStream} to increase
reusability, because {@link FilterInputStream} changes the methods being called,
+ * such as read(byte[]) to read(byte[], int, int).
*
*
- * See the protected methods for ways in which a subclass can easily decorate
- * a stream with custom pre-, post- or error processing functionality.
+ * In addition, this class allows you to:
*
+ *
+ * notify a subclass that n bytes are about to be read through
{@link #beforeRead(int)}
+ * notify a subclass that n bytes were read through {@link
#afterRead(int)}
+ * notify a subclass that an exception was caught through {@link
#handleIOException(IOException)}
+ * {@link #unwrap()} itself
+ *
*/
public abstract class ProxyInputStream extends FilterInputStream {
@@ -71,7 +73,7 @@ public abstract class ProxyInputStream extends
FilterInputStream {
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void afterRead(final int n) throws IOException {
-// no-op
+// no-op default
}
/**
@@ -112,7 +114,7 @@ public abstract class ProxyInputStream extends
FilterInputStream {
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void beforeRead(final int n) throws IOException {
-// no-op
+// no-op default
}
/**
(commons-io) branch master updated: Javadoc #574
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 1f419c7be Javadoc #574 1f419c7be is described below commit 1f419c7bef9beedce5d62ae00bbd273096833adf Author: Gary Gregory AuthorDate: Wed Jan 31 10:33:07 2024 -0500 Javadoc #574 --- src/changes/changes.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index f8dda510d..70acfcd9a 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -104,7 +104,7 @@ The type attribute can be add,update,fix,remove. Add characterization test for copying a symlinked directory #570. RandomAccessFileInputStream.builder().get() now throws ISE instead of NPE. Test links to targets outside the source directory #571. - Focus Javadoc on current version rather than past versions #573. + Focus Javadoc on current version rather than past versions #573, #574. Add and use PathUtils.getFileName(Path, FunctionPath, R). Add and use PathUtils.getFileNameString().
(commons-io) branch master updated: Javadoc
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 58dce3d55 Javadoc
58dce3d55 is described below
commit 58dce3d5577ddaf91995ba033e7255cbd048dbab
Author: Gary Gregory
AuthorDate: Tue Jan 30 08:49:56 2024 -0500
Javadoc
---
.../commons/io/monitor/FileAlterationObserver.java | 61 +++---
1 file changed, 30 insertions(+), 31 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
index ee10008cd..aa4c099c5 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -115,7 +115,6 @@ import org.apache.commons.io.filefilter.TrueFileFilter;
*
* @see FileAlterationListener
* @see FileAlterationMonitor
- *
* @since 2.0
*/
public class FileAlterationObserver implements Serializable {
@@ -156,7 +155,7 @@ public class FileAlterationObserver implements Serializable
{
/**
* Constructs an observer for the specified directory.
*
- * @param directory the directory to observe
+ * @param directory the directory to observe.
*/
public FileAlterationObserver(final File directory) {
this(directory, null);
@@ -165,8 +164,8 @@ public class FileAlterationObserver implements Serializable
{
/**
* Constructs an observer for the specified directory and file filter.
*
- * @param directory the directory to observe
- * @param fileFilter The file filter or null if none
+ * @param directory the directory to observe.
+ * @param fileFilter The file filter or null if none.
*/
public FileAlterationObserver(final File directory, final FileFilter
fileFilter) {
this(directory, fileFilter, null);
@@ -212,7 +211,7 @@ public class FileAlterationObserver implements Serializable
{
/**
* Constructs an observer for the specified directory.
*
- * @param directoryName the name of the directory to observe
+ * @param directoryName the name of the directory to observe.
*/
public FileAlterationObserver(final String directoryName) {
this(new File(directoryName));
@@ -221,8 +220,8 @@ public class FileAlterationObserver implements Serializable
{
/**
* Constructs an observer for the specified directory and file filter.
*
- * @param directoryName the name of the directory to observe
- * @param fileFilterThe file filter or null if none
+ * @param directoryName the name of the directory to observe.
+ * @param fileFilterThe file filter or null if none.
*/
public FileAlterationObserver(final String directoryName, final FileFilter
fileFilter) {
this(new File(directoryName), fileFilter);
@@ -231,9 +230,9 @@ public class FileAlterationObserver implements Serializable
{
/**
* Constructs an observer for the specified directory, file filter and
file comparator.
*
- * @param directoryName the name of the directory to observe
- * @param fileFilterThe file filter or null if none
- * @param ioCasewhat case sensitivity to use comparing file names,
null means system sensitive
+ * @param directoryName the name of the directory to observe.
+ * @param fileFilterThe file filter or null if none.
+ * @param ioCasewhat case sensitivity to use comparing file names,
null means system sensitive.
*/
public FileAlterationObserver(final String directoryName, final FileFilter
fileFilter, final IOCase ioCase) {
this(new File(directoryName), fileFilter, ioCase);
@@ -242,7 +241,7 @@ public class FileAlterationObserver implements Serializable
{
/**
* Adds a file system listener.
*
- * @param listener The file system listener
+ * @param listener The file system listener.
*/
public void addListener(final FileAlterationListener listener) {
if (listener != null) {
@@ -274,9 +273,9 @@ public class FileAlterationObserver implements Serializable
{
/**
* Compares two file lists for files which have been created, modified or
deleted.
*
- * @param parent The parent entry
- * @param previous The original list of files
- * @param filesThe current list of files
+ * @param parent The parent entry.
+ * @param previous The original list of files.
+ * @param filesThe current list of files.
*/
private void checkAndNotify(final FileEntry parent, final FileEntry[]
previous, final File[] files) {
int c = 0;
@@ -307,9 +306,9 @@ public class FileAlterationObserver implements Serializable
{
/**
* Creates a new file entry for the
(commons-io) branch master updated: Javadoc
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 062eab5a0 Javadoc
062eab5a0 is described below
commit 062eab5a0a7dd3e18e69c26899133e77bb4dcfad
Author: Gary Gregory
AuthorDate: Tue Jan 30 08:33:23 2024 -0500
Javadoc
- Close HTML tags
- Add missing HTML tags
---
.../commons/io/monitor/FileAlterationObserver.java | 98 ++
1 file changed, 45 insertions(+), 53 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
index e862f36ee..34fe60e39 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -18,6 +18,7 @@ package org.apache.commons.io.monitor;
import java.io.File;
import java.io.FileFilter;
+import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
@@ -29,34 +30,32 @@ import java.util.stream.Stream;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOCase;
+import org.apache.commons.io.build.AbstractSupplier;
+import org.apache.commons.io.comparator.DefaultFileComparator;
import org.apache.commons.io.comparator.NameFileComparator;
import org.apache.commons.io.filefilter.TrueFileFilter;
/**
- * FileAlterationObserver represents the state of files below a root directory,
- * checking the file system and notifying listeners of create, change or
- * delete events.
+ * FileAlterationObserver represents the state of files below a root
directory, checking the file system and notifying listeners of create, change
or delete
+ * events.
*
* To use this implementation:
+ *
*
- * Create {@link FileAlterationListener} implementation(s) that process
- * the file/directory create, change and delete events
- * Register the listener(s) with a {@link FileAlterationObserver} for
- * the appropriate directory.
- * Either register the observer(s) with a {@link FileAlterationMonitor}
or
- * run manually.
+ * Create {@link FileAlterationListener} implementation(s) that process
the file/directory create, change and delete events
+ * Register the listener(s) with a {@link FileAlterationObserver} for the
appropriate directory.
+ * Either register the observer(s) with a {@link FileAlterationMonitor} or
run manually.
*
- *
- * Basic Usage
- * Create a {@link FileAlterationObserver} for the directory and register the
listeners:
+ * Basic Usage Create a {@link FileAlterationObserver} for the
directory and register the listeners:
*
* File directory = new File(FileUtils.current(), "src");
* FileAlterationObserver observer = new
FileAlterationObserver(directory);
* observer.addListener(...);
* observer.addListener(...);
*
- * To manually observe a directory, initialize the observer and invoked the
- * {@link #checkAndNotify()} method as required:
+ *
+ * To manually observe a directory, initialize the observer and invoked the
{@link #checkAndNotify()} method as required:
+ *
*
* // initialize
* observer.init();
@@ -69,8 +68,9 @@ import org.apache.commons.io.filefilter.TrueFileFilter;
* // finished
* observer.finish();
*
- * Alternatively, register the observer(s) with a {@link
FileAlterationMonitor},
- * which creates a new thread, invoking the observer at the specified interval:
+ *
+ * Alternatively, register the observer(s) with a {@link
FileAlterationMonitor}, which creates a new thread, invoking the observer at
the specified interval:
+ *
*
* long interval = ...
* FileAlterationMonitor monitor = new FileAlterationMonitor(interval);
@@ -79,21 +79,16 @@ import org.apache.commons.io.filefilter.TrueFileFilter;
* ...
* monitor.stop();
*
- *
- * File Filters
- * This implementation can monitor portions of the file system
- * by using {@link FileFilter}s to observe only the files and/or directories
- * that are of interest. This makes it more efficient and reduces the
- * noise from unwanted file system events.
+ * File Filters This implementation can monitor portions of the file
system by using {@link FileFilter}s to observe only the files and/or directories
+ * that are of interest. This makes it more efficient and reduces the noise
from unwanted file system events.
*
- * https://commons.apache.org/io/;>Commons IO has a good range of
- * useful, ready-made
- * File Filter
+ * https://commons.apache.org/io/;>Commons IO has a good range of
useful, ready-made File Filter
* implementations for this purpose.
+ *
*
- * For example, to only observe 1) visible directories and 2) files with a
".java" suffix
- * in a root
(commons-io) branch master updated: Javadoc
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 5e3c7e8f Javadoc
5e3c7e8f is described below
commit 5e3c7e8ff7ebf048f2555028a86732a81d2ae7e1
Author: Gary Gregory
AuthorDate: Sun Jan 28 08:49:53 2024 -0500
Javadoc
---
.../commons/io/build/AbstractStreamBuilder.java| 13 +++---
.../commons/io/filefilter/WildcardFileFilter.java | 2 +-
.../commons/io/input/AutoCloseInputStream.java | 52 --
.../apache/commons/io/input/BOMInputStream.java| 25 ---
.../commons/io/input/BoundedInputStream.java | 36 +++
.../io/input/BufferedFileChannelInputStream.java | 23 +++---
.../commons/io/input/CharSequenceInputStream.java | 22 +++--
.../commons/io/input/ChecksumInputStream.java | 26 ---
.../io/input/MemoryMappedFileInputStream.java | 23 +++---
.../input/MessageDigestCalculatingInputStream.java | 23 +++---
.../commons/io/input/MessageDigestInputStream.java | 23 +++---
.../apache/commons/io/input/QueueInputStream.java | 19 +---
.../io/input/RandomAccessFileInputStream.java | 26 +++
.../commons/io/input/ReadAheadInputStream.java | 20 ++---
.../apache/commons/io/input/ReaderInputStream.java | 25 ---
.../commons/io/input/ReversedLinesFileReader.java | 24 +++---
.../java/org/apache/commons/io/input/Tailer.java | 45 +--
.../commons/io/input/ThrottledInputStream.java | 41 -
.../commons/io/input/UncheckedBufferedReader.java | 20 +++--
.../io/input/UncheckedFilterInputStream.java | 20 ++---
.../commons/io/input/UncheckedFilterReader.java| 21 ++---
.../input/UnsynchronizedBufferedInputStream.java | 21 ++---
.../input/UnsynchronizedByteArrayInputStream.java | 44 --
.../io/input/UnsynchronizedFilterInputStream.java | 19 +---
.../apache/commons/io/input/XmlStreamReader.java | 25 ---
.../commons/io/output/ChunkedOutputStream.java | 22 ++---
.../io/output/DeferredFileOutputStream.java| 20 +++--
.../commons/io/output/FileWriterWithEncoding.java | 19 +---
.../commons/io/output/LockableFileWriter.java | 21 ++---
.../io/output/UncheckedFilterOutputStream.java | 23 ++
.../commons/io/output/UncheckedFilterWriter.java | 18 +---
.../UnsynchronizedByteArrayOutputStream.java | 16 +--
.../commons/io/output/WriterOutputStream.java | 20 ++---
.../apache/commons/io/output/XmlStreamWriter.java | 23 ++
34 files changed, 580 insertions(+), 240 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
index 4262c690..7b113237 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
@@ -141,13 +141,14 @@ public abstract class AbstractStreamBuilder
*
- * To build an instance, see {@link Builder}.
+ * To build an instance, use {@link Builder}.
*
*
* For example:
diff --git
a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
index 816bbf3a..d7c705f4 100644
--- a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
@@ -24,52 +24,57 @@ import java.io.InputStream;
import org.apache.commons.io.build.AbstractStreamBuilder;
/**
- * Proxy stream that closes and discards the underlying stream as soon as the
- * end of input has been reached or when the stream is explicitly closed.
- * Not even a reference to the underlying stream is kept after it has been
- * closed, so any allocated in-memory buffers can be freed even if the
- * client application still keeps a reference to the proxy stream.
+ * Proxy stream that closes and discards the underlying stream as soon as the
end of input has been reached or when the stream is explicitly closed. Not even
a
+ * reference to the underlying stream is kept after it has been closed, so any
allocated in-memory buffers can be freed even if the client application still
+ * keeps a reference to the proxy stream.
*
- * This class is typically used to release any resources related to an open
- * stream as soon as possible even if the client application (by not explicitly
- * closing the stream when no longer needed) or the underlying stream (by not
- * releasing resources once the last byte has been read) do not do that.
+ * This class is typically used to release any resources related to an open
stream as soon as possible even if the client application (by not explicitly
(commons-io) branch master updated: Javadoc
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 15b2ac6c Javadoc
15b2ac6c is described below
commit 15b2ac6c6e84782e55d99208d5112a4a890c5d1d
Author: Gary Gregory
AuthorDate: Sat Jan 27 18:22:29 2024 -0500
Javadoc
---
.../apache/commons/io/build/AbstractStreamBuilder.java | 18 +-
.../apache/commons/io/input/AutoCloseInputStream.java | 11 ---
.../org/apache/commons/io/input/BOMInputStream.java| 9 +
.../apache/commons/io/input/BoundedInputStream.java| 12
.../io/input/BufferedFileChannelInputStream.java | 15 +++
.../apache/commons/io/input/ChecksumInputStream.java | 10 --
.../commons/io/input/MemoryMappedFileInputStream.java | 15 +++
.../io/input/MessageDigestCalculatingInputStream.java | 11 +--
.../commons/io/input/MessageDigestInputStream.java | 11 +--
.../commons/io/input/RandomAccessFileInputStream.java | 4 +++-
.../apache/commons/io/input/ReadAheadInputStream.java | 10 ++
.../commons/io/input/ReversedLinesFileReader.java | 16
.../apache/commons/io/input/ThrottledInputStream.java | 12
.../io/input/UnsynchronizedBufferedInputStream.java| 11 +++
.../io/input/UnsynchronizedFilterInputStream.java | 9 +
.../org/apache/commons/io/input/XmlStreamReader.java | 12 ++--
16 files changed, 109 insertions(+), 77 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
index e0f9ba66..4262c690 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
@@ -112,9 +112,9 @@ public abstract class AbstractStreamBuilder
- * This builder use the aspect InputStream.
+ * You must provide an origin that supports calling {@link
#getInputStream()} on this builder, otherwise, this method throws an exception.
+ *
+ *
+ * This builder use the aspects InputStream, OpenOption[], include,
and ByteOrderMark[].
*
*
* @return a new instance.
- * @throws IOException if an I/O error occurs.
- * @throws IllegalArgumentException if the buffer is not large enough
to hold a complete character.
+ * @throws IllegalStateException if the {@code origin} is
{@code null}.
+ * @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
+ * @throws IOException if an I/O error occurs.
+ * @see #getInputStream()
*/
@SuppressWarnings("resource") // Caller closes
@Override
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 3a2aed52..ad723f7b 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -138,15 +138,16 @@ public class BOMInputStream extends ProxyInputStream {
/**
* Constructs a new instance.
*
- * This builder use the aspects InputStream, OpenOption[], include,
and ByteOrderMark[].
+ * You must provide an origin that supports calling {@link
#getInputStream()} on this builder, otherwise, this method throws an exception.
*
*
- * You must provide an origin that can be converted to an InputStream
by this builder, otherwise, this call will throw an
- * {@link UnsupportedOperationException}.
+ * This builder use the aspects InputStream, OpenOption[], include,
and ByteOrderMark[].
*
*
* @return a new instance.
- * @throws UnsupportedOperationException if the origin cannot provide
an InputStream.
+ * @throws IllegalStateException if the {@code origin} is
{@code null}.
+ * @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
+ * @throws IOException if an I/O error occurs.
* @see #getInputStream()
*/
@SuppressWarnings("resource")
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
index f3d7e6f1..f6f4373f 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -65,6 +65,18 @@ public class BoundedInputStream extends ProxyInputStream {
/** Flag if close should be
(commons-io) branch master updated: Javadoc: Normalize @deprecated
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 e99c56f1 Javadoc: Normalize @deprecated
e99c56f1 is described below
commit e99c56f1e7985576af0d2a5943459d70bc6ab85f
Author: Gary Gregory
AuthorDate: Thu Jan 25 14:05:35 2024 -0500
Javadoc: Normalize @deprecated
We don't need to specify when a method was @deprecated.
---
src/main/java/org/apache/commons/io/CopyUtils.java | 8 ++---
src/main/java/org/apache/commons/io/FileUtils.java | 12
src/main/java/org/apache/commons/io/IOUtils.java | 34 +++---
.../io/output/AbstractByteArrayOutputStream.java | 2 +-
.../commons/io/output/LockableFileWriter.java | 2 +-
5 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/CopyUtils.java
b/src/main/java/org/apache/commons/io/CopyUtils.java
index 4dc6de41..ad562aa6 100644
--- a/src/main/java/org/apache/commons/io/CopyUtils.java
+++ b/src/main/java/org/apache/commons/io/CopyUtils.java
@@ -131,7 +131,7 @@ public class CopyUtils {
* @param input the byte array to read from
* @param output the {@link Writer} to write to
* @throws IOException In case of an I/O problem
- * @deprecated 2.5 use {@link #copy(byte[], Writer, String)} instead
+ * @deprecated Use {@link #copy(byte[], Writer, String)} instead
*/
@Deprecated
public static void copy(final byte[] input, final Writer output) throws
IOException {
@@ -183,7 +183,7 @@ public class CopyUtils {
* @param input the {@link InputStream} to read from
* @param output the {@link Writer} to write to
* @throws IOException In case of an I/O problem
- * @deprecated 2.5 use {@link #copy(InputStream, Writer, String)} instead
+ * @deprecated Use {@link #copy(InputStream, Writer, String)} instead
*/
@Deprecated
public static void copy(
@@ -223,7 +223,7 @@ public class CopyUtils {
* @param input the {@link Reader} to read from
* @param output the {@link OutputStream} to write to
* @throws IOException In case of an I/O problem
- * @deprecated 2.5 use {@link #copy(Reader, OutputStream, String)} instead
+ * @deprecated Use {@link #copy(Reader, OutputStream, String)} instead
*/
@Deprecated
public static void copy(
@@ -293,7 +293,7 @@ public class CopyUtils {
* @param input the {@link String} to read from
* @param output the {@link OutputStream} to write to
* @throws IOException In case of an I/O problem
- * @deprecated 2.5 use {@link #copy(String, OutputStream, String)} instead
+ * @deprecated Use {@link #copy(String, OutputStream, String)} instead
*/
@Deprecated
public static void copy(
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index f83cf09b..c7bbbdfc 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -2658,7 +2658,7 @@ public class FileUtils {
* @throws IOException if an I/O error occurs, including when the file
does not exist, is a directory rather than a
* regular file, or for some other reason why the file cannot be
opened for reading.
* @since 1.3.1
- * @deprecated 2.5 use {@link #readFileToString(File, Charset)} instead
(and specify the appropriate encoding)
+ * @deprecated Use {@link #readFileToString(File, Charset)} instead (and
specify the appropriate encoding)
*/
@Deprecated
public static String readFileToString(final File file) throws IOException {
@@ -2708,7 +2708,7 @@ public class FileUtils {
* @throws IOException if an I/O error occurs, including when the file
does not exist, is a directory rather than a
* regular file, or for some other reason why the file cannot be
opened for reading.
* @since 1.3
- * @deprecated 2.5 use {@link #readLines(File, Charset)} instead (and
specify the appropriate encoding)
+ * @deprecated Use {@link #readLines(File, Charset)} instead (and specify
the appropriate encoding)
*/
@Deprecated
public static List readLines(final File file) throws IOException {
@@ -3137,7 +3137,7 @@ public class FileUtils {
* @param data the content to write to the file
* @throws IOException in case of an I/O error
* @since 2.0
- * @deprecated 2.5 use {@link #write(File, CharSequence, Charset)} instead
(and specify the appropriate encoding)
+ * @deprecated Use {@link #write(File, CharSequence, Charset)} instead
(and specify the appropriate encoding)
*/
@Deprecated
public static void write(final File file, final CharSequence data) throws
IOException {
@@ -3153,7 +3153,7 @@ public class FileUtils {
*
(commons-io) branch master updated: Javadoc: Use an HTTPS URL
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 876e8c34 Javadoc: Use an HTTPS URL 876e8c34 is described below commit 876e8c34b1a2fbee5481d867ca9261d5fbe77738 Author: Gary Gregory AuthorDate: Sun Jan 14 10:44:29 2024 -0500 Javadoc: Use an HTTPS URL --- .../org/apache/commons/io/input/compatibility/XmlStreamReader.java| 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java index a8299dc7..f1d7526b 100644 --- a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java +++ b/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java @@ -58,11 +58,11 @@ import org.apache.commons.io.output.XmlStreamWriter; * By default the charset encoding detection is lenient, the constructor with * the lenient flag can be used for a script (following HTTP MIME and XML * specifications). All this is nicely explained by Mark Pilgrim in his blog, http://diveintomark.org/archives/2004/02/13/xml-media-types;> + * href="https://diveintomark.org/archives/2004/02/13/xml-media-types;> * Determining the character encoding of a feed. * * - * Originally developed for http://rome.dev.java.net;>ROME under + * Originally developed for https://rome.dev.java.net;>ROME under * Apache License 2.0. * *
(commons-io) branch master updated: Javadoc: Use an HTTPS URL to the Apache web site
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 4616d0f0 Javadoc: Use an HTTPS URL to the Apache web site
4616d0f0 is described below
commit 4616d0f03d91e53ee8b760abeec1c42a1c0c8b01
Author: Gary Gregory
AuthorDate: Sun Jan 14 10:43:43 2024 -0500
Javadoc: Use an HTTPS URL to the Apache web site
---
src/main/java/org/apache/commons/io/ByteOrderMark.java | 4 ++--
src/main/java/org/apache/commons/io/DirectoryWalker.java | 2 +-
src/main/java/org/apache/commons/io/FileSystemUtils.java | 6 +++---
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 2 +-
src/main/java/org/apache/commons/io/input/XmlStreamReader.java | 4 ++--
5 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java
b/src/main/java/org/apache/commons/io/ByteOrderMark.java
index c5ab57b1..6e87d6b3 100644
--- a/src/main/java/org/apache/commons/io/ByteOrderMark.java
+++ b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -39,7 +39,7 @@ import java.util.Objects;
*
*
* @see org.apache.commons.io.input.BOMInputStream
- * @see http://en.wikipedia.org/wiki/Byte_order_mark;>Wikipedia: Byte
Order Mark
+ * @see https://en.wikipedia.org/wiki/Byte_order_mark;>Wikipedia:
Byte Order Mark
* @see http://www.w3.org/TR/2006/REC-xml-20060816/#sec-guessing;>W3C:
Autodetection of Character Encodings
* (Non-Normative)
* @since 2.0
@@ -110,7 +110,7 @@ public class ByteOrderMark implements Serializable {
/**
* Unicode BOM character; external form depends on the encoding.
*
- * @see http://unicode.org/faq/utf_bom.html#BOM;>Byte Order Mark
(BOM) FAQ
+ * @see https://unicode.org/faq/utf_bom.html#BOM;>Byte Order Mark
(BOM) FAQ
* @since 2.5
*/
public static final char UTF_BOM = '\uFEFF';
diff --git a/src/main/java/org/apache/commons/io/DirectoryWalker.java
b/src/main/java/org/apache/commons/io/DirectoryWalker.java
index 468682e8..55dfe901 100644
--- a/src/main/java/org/apache/commons/io/DirectoryWalker.java
+++ b/src/main/java/org/apache/commons/io/DirectoryWalker.java
@@ -187,7 +187,7 @@ import org.apache.commons.io.filefilter.TrueFileFilter;
*
* This example provides a public {@code cancel()} method that can be called
by another thread to stop the
* processing. A typical example use-case would be a cancel button on a GUI.
Calling this method sets a
- * http://java.sun.com/docs/books/jls/second_edition/html/classes.doc.html#36930;>
volatile flag to ensure
+ * https://java.sun.com/docs/books/jls/second_edition/html/classes.doc.html#36930;>
volatile flag to ensure
* it will work properly in a multi-threaded environment. The flag is returned
by the {@code handleIsCancelled()}
* method, which will cause the walk to stop immediately. The {@code
handleCancelled()} method will be the next,
* and last, callback method received once cancellation has occurred.
diff --git a/src/main/java/org/apache/commons/io/FileSystemUtils.java
b/src/main/java/org/apache/commons/io/FileSystemUtils.java
index 57f312ec..8a244ec1 100644
--- a/src/main/java/org/apache/commons/io/FileSystemUtils.java
+++ b/src/main/java/org/apache/commons/io/FileSystemUtils.java
@@ -469,9 +469,9 @@ public class FileSystemUtils {
//
// This method does what it can to avoid the 'Too many open files'
error
// based on trial and error and these links:
-// http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4784692
-// http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4801027
-//
http://forum.java.sun.com/thread.jspa?threadID=533029=2572018
+// https://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4784692
+// https://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4801027
+//
https://forum.java.sun.com/thread.jspa?threadID=533029=2572018
// however, it's still not perfect as the JDK support is so poor
// (see commons-exec or Ant for a better multithreaded multi-OS
solution)
//
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index c5bebc7c..b113a0f3 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -91,7 +91,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*
*
* @see org.apache.commons.io.ByteOrderMark
- * @see http://en.wikipedia.org/wiki/Byte_order_mark;>Wikipedia -
Byte Order Mark
+ * @see https://en.wikipedia.org/wiki/Byte_order_mark;>Wikipedia -
Byte Order Mark
* @since 2.0
*/
public class BOMInputStream extends ProxyInputStream {
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
(commons-io) branch master updated: Javadoc
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 1a6c3318 Javadoc
1a6c3318 is described below
commit 1a6c3318ef48c64e975a32836539312ef011ae4f
Author: Gary Gregory
AuthorDate: Sun Jan 14 08:40:31 2024 -0500
Javadoc
---
src/main/java/org/apache/commons/io/input/ProxyInputStream.java | 8
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index fb40ae10..b5741cd0 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -66,8 +66,8 @@ public abstract class ProxyInputStream extends
FilterInputStream {
*
*
* @since 2.0
- * @param n number of bytes read, or -1 if the end of stream was reached
- * @throws IOException if the post-processing fails
+ * @param n number of bytes read, or -1 if the end of stream was reached.
+ * @throws IOException if the post-processing fails in a subclass.
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void afterRead(final int n) throws IOException {
@@ -107,8 +107,8 @@ public abstract class ProxyInputStream extends
FilterInputStream {
*
*
* @since 2.0
- * @param n number of bytes that the caller asked to be read
- * @throws IOException if the pre-processing fails
+ * @param n number of bytes that the caller asked to be read.
+ * @throws IOException if the pre-processing fails in a subclass.
*/
@SuppressWarnings("unused") // Possibly thrown from subclasses.
protected void beforeRead(final int n) throws IOException {
(commons-io) branch master updated: Javadoc
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 877d3404 Javadoc
877d3404 is described below
commit 877d3404c073f31dcc26d0ae44905c28f860a5b3
Author: Gary Gregory
AuthorDate: Sun Jan 14 08:39:36 2024 -0500
Javadoc
---
src/main/java/org/apache/commons/io/input/ProxyInputStream.java | 7 ---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index fa963b39..fb40ae10 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -51,7 +51,7 @@ public abstract class ProxyInputStream extends
FilterInputStream {
}
/**
- * Invoked by the read methods after the proxied call has returned
+ * Invoked by the {@code read} methods after the proxied call has returned
* successfully. The number of bytes returned to the caller (or -1 if
* the end of stream was reached) is given as an argument.
*
@@ -76,6 +76,7 @@ public abstract class ProxyInputStream extends
FilterInputStream {
/**
* Invokes the delegate's {@code available()} method.
+ *
* @return the number of available bytes
* @throws IOException if an I/O error occurs.
*/
@@ -90,7 +91,7 @@ public abstract class ProxyInputStream extends
FilterInputStream {
}
/**
- * Invoked by the read methods before the call is proxied. The number
+ * Invoked by the {@code read} methods before the call is proxied. The
number
* of bytes that the caller wanted to read (1 for the {@link #read()}
* method, buffer length for {@link #read(byte[])}, etc.) is given as
* an argument.
@@ -125,7 +126,7 @@ public abstract class ProxyInputStream extends
FilterInputStream {
}
/**
- * Handle any IOExceptions thrown; by default, throws the given exception.
+ * Handles any IOExceptions thrown; by default, throws the given exception.
*
* This method provides a point to implement custom exception
* handling. The default behavior is to re-throw the exception.
(commons-io) branch master updated: Javadoc
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 f94af4ae Javadoc
f94af4ae is described below
commit f94af4ae6ed41d379a3dba10d389b6ec1a5394fc
Author: Gary Gregory
AuthorDate: Sat Jan 13 09:49:26 2024 -0500
Javadoc
---
.../java/org/apache/commons/io/output/DeferredFileOutputStream.java | 2 ++
.../java/org/apache/commons/io/output/FileWriterWithEncoding.java | 6 --
src/main/java/org/apache/commons/io/output/LockableFileWriter.java | 2 ++
.../org/apache/commons/io/output/UncheckedFilterOutputStream.java | 2 ++
.../java/org/apache/commons/io/output/UncheckedFilterWriter.java| 2 ++
.../commons/io/output/UnsynchronizedByteArrayOutputStream.java | 2 ++
src/main/java/org/apache/commons/io/output/WriterOutputStream.java | 2 ++
src/main/java/org/apache/commons/io/output/XmlStreamWriter.java | 2 ++
8 files changed, 18 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
index 3382bdcd..045eae4a 100644
--- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
@@ -41,6 +41,7 @@ import org.apache.commons.io.file.PathUtils;
*/
public class DeferredFileOutputStream extends ThresholdingOutputStream {
+// @formatter:off
/**
* Builds a new {@link DeferredFileOutputStream} instance.
*
@@ -62,6 +63,7 @@ public class DeferredFileOutputStream extends
ThresholdingOutputStream {
*
* @since 2.12.0
*/
+// @formatter:on
public static class Builder extends
AbstractStreamBuilder {
private int threshold;
diff --git
a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
index 751f0e36..d583b232 100644
--- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
+++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
@@ -51,13 +51,14 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*/
public class FileWriterWithEncoding extends ProxyWriter {
+// @formatter:off
/**
* Builds a new {@link FileWriterWithEncoding} instance.
*
* Using a CharsetEncoder:
*
* {@code
- * FileWriterWithEncoding s = FileWriterWithEncoding.builder()
+ * FileWriterWithEncoding w = FileWriterWithEncoding.builder()
* .setPath(path)
* .setAppend(false)
* .setCharsetEncoder(StandardCharsets.UTF_8.newEncoder())
@@ -67,7 +68,7 @@ public class FileWriterWithEncoding extends ProxyWriter {
* Using a Charset:
*
* {@code
- * FileWriterWithEncoding s = FileWriterWithEncoding.builder()
+ * FileWriterWithEncoding w = FileWriterWithEncoding.builder()
* .setPath(path)
* .setAppend(false)
* .setCharsetEncoder(StandardCharsets.UTF_8)
@@ -76,6 +77,7 @@ public class FileWriterWithEncoding extends ProxyWriter {
*
* @since 2.12.0
*/
+// @formatter:on
public static class Builder extends
AbstractStreamBuilder {
private boolean append;
diff --git a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
index b33abc81..acc28f7d 100644
--- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
+++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
@@ -50,6 +50,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*/
public class LockableFileWriter extends Writer {
+// @formatter:off
/**
* Builds a new {@link LockableFileWriter} instance.
*
@@ -65,6 +66,7 @@ public class LockableFileWriter extends Writer {
*
* @since 2.12.0
*/
+// @formatter:on
public static class Builder extends
AbstractStreamBuilder {
private boolean append;
diff --git
a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
index 91f115db..aadc6240 100644
---
a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
+++
b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
@@ -38,6 +38,7 @@ import org.apache.commons.io.function.Uncheck;
*/
public final class UncheckedFilterOutputStream extends FilterOutputStream {
+// @formatter:off
/**
* Builds a new {@link UncheckedFilterOutputStream} instance.
*
@@ -57,6 +58,7 @@ public final class UncheckedFilterOutputStream extends
FilterOutputStream {
* .get();}
*
(commons-io) branch master updated: Javadoc
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 2d2a4d28 Javadoc
2d2a4d28 is described below
commit 2d2a4d280b289038005dd1462ea60d0c485fbbed
Author: Gary Gregory
AuthorDate: Tue Jan 2 11:07:31 2024 -0500
Javadoc
---
.../java/org/apache/commons/io/input/XmlStreamReader.java | 14 +-
1 file changed, 5 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
index ff16987f..21ce82db 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -210,9 +210,9 @@ public class XmlStreamReader extends Reader {
private static final Pattern CHARSET_PATTERN =
Pattern.compile("charset=[\"']?([.[^; \"']]*)[\"']?");
/**
- * Pattern capturing the encoding of the "xml" processing instruction.
+ * Pattern capturing the encoding of the https://www.w3.org/TR/REC-xml/#sec-pi;>{@code 'xml'} processing
instruction.
*
- * See also the https://www.w3.org/TR/2008/REC-xml-20081126/#NT-EncName;>XML
specification.
+ * See also the https://www.w3.org/TR/2008/REC-xml-20081126/#NT-EncName;>NT-EncName
XML specification.
*
*
* Note the documented pattern is:
@@ -221,8 +221,8 @@ public class XmlStreamReader extends Reader {
* EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
*
*
- * However this does not match all the aliases that are supported by Java.
- * For example, '437', 'ISO_8859-1:1987' and 'ebcdic-de-273+euro'.
+ * However this does not match all the aliases that are supported by Java.
For example, {@code '437'}, {@code 'ISO_8859-1:1987'} and
+ * {@code 'ebcdic-de-273+euro'}.
*
*/
public static final Pattern ENCODING_PATTERN = Pattern.compile(
@@ -285,11 +285,7 @@ public class XmlStreamReader extends Reader {
String mime = null;
if (httpContentType != null) {
final int i = httpContentType.indexOf(";");
-if (i >= 0) {
-mime = httpContentType.substring(0, i);
-} else {
-mime = httpContentType;
-}
+mime = i >= 0 ? httpContentType.substring(0, i) : httpContentType;
mime = mime.trim();
}
return mime;
(commons-io) branch master updated: Javadoc
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 bbff10de Javadoc
bbff10de is described below
commit bbff10dec4c6473b219fc715e78963dbdb1b5e09
Author: Gary Gregory
AuthorDate: Tue Jan 2 09:38:13 2024 -0500
Javadoc
---
src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
b/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
index de986c98..46379abb 100644
--- a/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
@@ -49,6 +49,9 @@ import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import org.junitpioneer.jupiter.DefaultLocale;
+/**
+ * Tests {@link XmlStreamReader}.
+ */
public class XmlStreamReaderTest {
private static final String ISO_8859_1 =
StandardCharsets.ISO_8859_1.name();
(commons-io) branch master updated: Javadoc spelling
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 cd5057aa Javadoc spelling
cd5057aa is described below
commit cd5057aa5075541d3f12cd8e763dde02e8828802
Author: Gary Gregory
AuthorDate: Fri Dec 29 15:45:00 2023 -0500
Javadoc spelling
---
src/main/java/org/apache/commons/io/StandardLineSeparator.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/StandardLineSeparator.java
b/src/main/java/org/apache/commons/io/StandardLineSeparator.java
index 4d40ada2..13a6edd3 100644
--- a/src/main/java/org/apache/commons/io/StandardLineSeparator.java
+++ b/src/main/java/org/apache/commons/io/StandardLineSeparator.java
@@ -28,7 +28,7 @@ import java.util.Objects;
public enum StandardLineSeparator {
/**
- * Carriage return. This is the line ending used on Mac OS 9 and earlier.
+ * Carriage return. This is the line ending used on macOS 9 and earlier.
*/
CR("\r"),
@@ -38,7 +38,7 @@ public enum StandardLineSeparator {
CRLF("\r\n"),
/**
- * Line feed. This is the line ending used on Linux and Mac OS X and later.
+ * Line feed. This is the line ending used on Linux and macOS X and later.
*/
LF("\n");
(commons-io) branch master updated: Javadoc shouldn't reference 1.x behavior #539
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 98fb7eb5 Javadoc shouldn't reference 1.x behavior #539 98fb7eb5 is described below commit 98fb7eb5e9c6fc60a46d04c23101d8c0a0545975 Author: Gary Gregory AuthorDate: Wed Dec 27 11:15:27 2023 -0500 Javadoc shouldn't reference 1.x behavior #539 --- src/changes/changes.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index e457f803..8a543742 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -45,7 +45,6 @@ The type attribute can be add,update,fix,remove. Apache Commons IO Release Notes - @@ -82,6 +81,7 @@ The type attribute can be add,update,fix,remove. Deprecate CountingInputStream.resetCount() in favor of resetByteCount(). Deprecate CountingInputStream.getMaxLength() in favor of getMaxCount()). NullInputStream breaks InputStream's read method contract. + Javadoc shouldn't reference 1.x behavior #539. Add and use PathUtils.getFileName(Path, FunctionPath, R). Add and use PathUtils.getFileNameString().
(commons-io) branch master updated: Javadoc
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 d57f3c7e Javadoc
d57f3c7e is described below
commit d57f3c7e2dccde72cbcb6849481f27feaea49401
Author: Gary Gregory
AuthorDate: Tue Dec 26 14:12:19 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java
b/src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java
index c782041c..c1562df5 100644
--- a/src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java
@@ -27,7 +27,7 @@ import java.nio.file.attribute.BasicFileAttributes;
import org.apache.commons.io.file.PathFilter;
/**
- * An interface which brings the FileFilter, FilenameFilter, PathFilter, and
PathMatcher interfaces together.
+ * An interface which brings the {@link FileFilter}, {@link FilenameFilter},
{@link PathFilter}, and {@link PathMatcher} interfaces together.
*
* @since 1.0
*/
@@ -56,7 +56,7 @@ public interface IOFileFilter extends FileFilter,
FilenameFilter, PathFilter, Pa
* Defined in {@link java.io.FilenameFilter}.
*
*
- * @param dir the directory File to check.
+ * @param dir the directory File to check.
* @param name the file name within the directory to check.
* @return true if this file matches the test.
*/
(commons-io) branch master updated: Javadoc
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 b059cd3a Javadoc
b059cd3a is described below
commit b059cd3a8d327f210df641c07f811a5ae94b5df5
Author: Gary Gregory
AuthorDate: Fri Dec 22 20:35:23 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/io/ThreadUtils.java | 9 +
.../org/apache/commons/io/comparator/DefaultFileComparator.java | 7 +++
.../java/org/apache/commons/io/input/TimestampedObserver.java| 7 +++
.../java/org/apache/commons/io/output/StringBuilderWriter.java | 4 ++--
4 files changed, 25 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ThreadUtils.java
b/src/main/java/org/apache/commons/io/ThreadUtils.java
index 153bd501..961f6f96 100644
--- a/src/main/java/org/apache/commons/io/ThreadUtils.java
+++ b/src/main/java/org/apache/commons/io/ThreadUtils.java
@@ -51,4 +51,13 @@ public final class ThreadUtils {
} while (!remainingDuration.isNegative());
}
+/**
+ * Consider private.
+ *
+ * @deprecated Will be private in the next major version.
+ */
+@Deprecated
+public ThreadUtils() {
+// empty
+}
}
diff --git
a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
index bf5a1c9a..c9d76e6a 100644
--- a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
@@ -59,6 +59,13 @@ public class DefaultFileComparator extends
AbstractFileComparator implements Ser
/** Singleton reverse default comparator instance */
public static final Comparator DEFAULT_REVERSE = new
ReverseFileComparator(DEFAULT_COMPARATOR);
+/**
+ * Constructs a new instance.
+ */
+public DefaultFileComparator() {
+// empty
+}
+
/**
* Compares the two files using the {@link File#compareTo(File)} method.
*
diff --git a/src/main/java/org/apache/commons/io/input/TimestampedObserver.java
b/src/main/java/org/apache/commons/io/input/TimestampedObserver.java
index c331c86c..27540b8d 100644
--- a/src/main/java/org/apache/commons/io/input/TimestampedObserver.java
+++ b/src/main/java/org/apache/commons/io/input/TimestampedObserver.java
@@ -45,6 +45,13 @@ public class TimestampedObserver extends Observer {
private volatile Instant closeInstant;
private final Instant openInstant = Instant.now();
+/**
+ * Constructs a new instance.
+ */
+public TimestampedObserver() {
+// empty
+}
+
@Override
public void closed() throws IOException {
closeInstant = Instant.now();
diff --git
a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
index f58b3750..eb6428e6 100644
--- a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
+++ b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
@@ -37,7 +37,7 @@ import java.io.Writer;
public class StringBuilderWriter extends Writer implements Serializable {
private static final long serialVersionUID = -146927496096066153L;
-
+
/** The append target. */
private final StringBuilder builder;
@@ -123,7 +123,7 @@ public class StringBuilderWriter extends Writer implements
Serializable {
}
/**
- * Returns the underlying builder.
+ * Gets the underlying builder.
*
* @return The underlying builder
*/
(commons-io) branch master updated: Javadoc
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 89ef7726 Javadoc
89ef7726 is described below
commit 89ef7726adab095ba700b3c6e48c9cb962b4f502
Author: Gary Gregory
AuthorDate: Fri Dec 22 20:09:47 2023 -0500
Javadoc
---
.../commons/io/monitor/FileAlterationObserver.java| 11 ++-
.../java/org/apache/commons/io/monitor/FileEntry.java | 19 +--
.../apache/commons/io/output/StringBuilderWriter.java | 2 ++
3 files changed, 25 insertions(+), 7 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
index c5960c44..a99368f7 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -357,7 +357,8 @@ public class FileAlterationObserver implements Serializable
{
}
/**
- * Lists the files
+ * Lists the files in {@code file}.
+ *
* @param file The file to list files for
* @param entry the parent entry
* @return The child files
@@ -429,14 +430,14 @@ public class FileAlterationObserver implements
Serializable {
/**
* Lists the contents of a directory
*
- * @param file The file to list the contents of
+ * @param directory The directory to list.
* @return the directory contents or a zero length array if
* the empty or the file is not a directory
*/
-private File[] listFiles(final File file) {
+private File[] listFiles(final File directory) {
File[] children = null;
-if (file.isDirectory()) {
-children = file.listFiles(fileFilter);
+if (directory.isDirectory()) {
+children = directory.listFiles(fileFilter);
}
if (children == null) {
children = FileUtils.EMPTY_FILE_ARRAY;
diff --git a/src/main/java/org/apache/commons/io/monitor/FileEntry.java
b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
index 837f2df5..2630cfae 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileEntry.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
@@ -57,13 +57,28 @@ public class FileEntry implements Serializable {
static final FileEntry[] EMPTY_FILE_ENTRY_ARRAY = {};
+/** The parent. */
private final FileEntry parent;
+
+/** My children. */
private FileEntry[] children;
+
+/** Monitored file. */
private final File file;
+
+/** Monitored file name. */
private String name;
+
+/** Whether the file exists. */
private boolean exists;
+
+/** Whether the file is a directory or not. */
private boolean directory;
+
+/** The file's last modified timestamp. */
private SerializableFileTime lastModified = SerializableFileTime.EPOCH;
+
+/** The file's length. */
private long length;
/**
@@ -78,8 +93,8 @@ public class FileEntry implements Serializable {
/**
* Constructs a new monitor for a specified {@link File}.
*
- * @param parent The parent
- * @param file The file being monitored
+ * @param parent The parent.
+ * @param file The file being monitored.
*/
public FileEntry(final FileEntry parent, final File file) {
this.file = Objects.requireNonNull(file, "file");
diff --git
a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
index dfea1c15..f58b3750 100644
--- a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
+++ b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
@@ -37,6 +37,8 @@ import java.io.Writer;
public class StringBuilderWriter extends Writer implements Serializable {
private static final long serialVersionUID = -146927496096066153L;
+
+/** The append target. */
private final StringBuilder builder;
/**
(commons-io) branch master updated: Javadoc spelling
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 035e0487 Javadoc spelling 035e0487 is described below commit 035e048708b8f64fda49810289a8f9fcdd3dd116 Author: Gary Gregory AuthorDate: Thu Dec 21 17:09:34 2023 -0500 Javadoc spelling --- src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java index 249baa87..303bfe28 100644 --- a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java +++ b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java @@ -27,7 +27,7 @@ import org.apache.commons.io.EndianUtils; /** * DataInput for systems relying on little-endian data formats. When read, values will be changed from little-endian to - * big endian formats for internal usage. + * big-endian formats for internal usage. * * Provenance: Avalon Excalibur (IO) *
(commons-io) branch master updated: Javadoc spelling
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 da749024 Javadoc spelling
da749024 is described below
commit da7490242f5d281e92c0ce80e22b282b1de0e3a5
Author: Gary Gregory
AuthorDate: Thu Dec 21 17:07:43 2023 -0500
Javadoc spelling
---
src/main/java/org/apache/commons/io/IOUtils.java | 2 +-
src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index 81584a68..6b48d09f 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -3828,7 +3828,7 @@ public class IOUtils {
* encoding and the specified line ending.
*
* UTF-16 is written big-endian with no byte order mark.
- * For little endian, use UTF-16LE. For a BOM, write it to the stream
+ * For little-endian, use UTF-16LE. For a BOM, write it to the stream
* before calling this method.
*
*
diff --git
a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
index 9239b520..249baa87 100644
--- a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
@@ -26,7 +26,7 @@ import java.io.InputStream;
import org.apache.commons.io.EndianUtils;
/**
- * DataInput for systems relying on little endian data formats. When read,
values will be changed from little endian to
+ * DataInput for systems relying on little-endian data formats. When read,
values will be changed from little-endian to
* big endian formats for internal usage.
*
* Provenance: Avalon Excalibur (IO)
(commons-io) branch master updated: Javadoc
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 2a0c2c4e Javadoc
2a0c2c4e is described below
commit 2a0c2c4e8337be1938984f6bfb71cf4fe37acd33
Author: Gary Gregory
AuthorDate: Sun Dec 17 14:35:22 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/io/output/StringBuilderWriter.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
index 39274d41..dfea1c15 100644
--- a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
+++ b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
@@ -23,10 +23,10 @@ import java.io.Writer;
* {@link Writer} implementation that outputs to a {@link StringBuilder}.
*
* NOTE: This implementation, as an alternative to
- * {@code java.io.StringWriter}, provides an un-synchronized
+ * {@link java.io.StringWriter}, provides an un-synchronized
* (i.e. for use in a single thread) implementation for better performance.
* For safe usage with multiple {@link Thread}s then
- * {@code java.io.StringWriter} should be used.
+ * {@link java.io.StringWriter} should be used.
*
* Deprecating Serialization
*
(commons-io) branch master updated: Javadoc
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 5dff9871 Javadoc
5dff9871 is described below
commit 5dff9871190c40edaeb9ec08ead1340b58679f46
Author: Gary Gregory
AuthorDate: Thu Dec 14 13:54:01 2023 -0500
Javadoc
---
src/test/java/org/apache/commons/io/DirectoryWalkerTest.java | 8
.../org/apache/commons/io/comparator/ComparatorAbstractTest.java | 4 ++--
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
index 0e92b4fd..e2aa2afd 100644
--- a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
+++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
@@ -52,7 +52,7 @@ public class DirectoryWalkerTest {
this.suppressCancel = suppressCancel;
}
-/** find files. */
+/** Find files. */
protected List find(final File startDirectory) throws
IOException {
final List results = new ArrayList<>();
walk(startDirectory, results);
@@ -115,7 +115,7 @@ public class DirectoryWalkerTest {
super(dirFilter, fileFilter, depthLimit);
}
-/** find files. */
+/** Find files. */
protected List find(final File startDirectory) {
final List results = new ArrayList<>();
try {
@@ -148,7 +148,7 @@ public class DirectoryWalkerTest {
super(filter, depthLimit);
}
-/** find files. */
+/** Find files. */
protected List find(final File startDirectory) {
final List results = new ArrayList<>();
try {
@@ -180,7 +180,7 @@ public class DirectoryWalkerTest {
this.suppressCancel = suppressCancel;
}
-/** find files. */
+/** Find files. */
protected List find(final File startDirectory) throws
IOException {
results = new ArrayList<>();
walk(startDirectory, results);
diff --git
a/src/test/java/org/apache/commons/io/comparator/ComparatorAbstractTest.java
b/src/test/java/org/apache/commons/io/comparator/ComparatorAbstractTest.java
index f752ef34..ddcd0326 100644
--- a/src/test/java/org/apache/commons/io/comparator/ComparatorAbstractTest.java
+++ b/src/test/java/org/apache/commons/io/comparator/ComparatorAbstractTest.java
@@ -38,10 +38,10 @@ public abstract class ComparatorAbstractTest {
@TempDir
public File dir;
-/** comparator instance */
+/** Comparator instance */
protected AbstractFileComparator comparator;
-/** reverse comparator instance */
+/** Reverse comparator instance */
protected Comparator reverse;
/** File which compares equal to "equalFile2" */
(commons-io) branch master updated: Javadoc: Remove redundant "java.lang" prefix
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 bf291ec2 Javadoc: Remove redundant "java.lang" prefix
bf291ec2 is described below
commit bf291ec2f482fb11df855305e80cc98992d8291b
Author: Gary Gregory
AuthorDate: Sat Dec 9 10:07:57 2023 -0500
Javadoc: Remove redundant "java.lang" prefix
---
.../java/org/apache/commons/io/output/AppendableOutputStream.java | 4 ++--
src/main/java/org/apache/commons/io/output/AppendableWriter.java | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java
b/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java
index 498c6c95..4500d4b7 100644
--- a/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java
@@ -23,8 +23,8 @@ import java.io.OutputStream;
* OutputStream implementation that writes the data to an {@link Appendable}
* Object.
*
- * For example, can be used with any {@link java.io.Writer} or a {@link
java.lang.StringBuilder}
- * or {@link java.lang.StringBuffer}.
+ * For example, can be used with any {@link java.io.Writer} or a {@link
StringBuilder}
+ * or {@link StringBuffer}.
*
*
* @since 2.5
diff --git a/src/main/java/org/apache/commons/io/output/AppendableWriter.java
b/src/main/java/org/apache/commons/io/output/AppendableWriter.java
index 38b5ba8d..830c17e7 100644
--- a/src/main/java/org/apache/commons/io/output/AppendableWriter.java
+++ b/src/main/java/org/apache/commons/io/output/AppendableWriter.java
@@ -24,8 +24,8 @@ import java.util.Objects;
* Writer implementation that writes the data to an {@link Appendable}
* Object.
*
- * For example, can be used with a {@link java.lang.StringBuilder}
- * or {@link java.lang.StringBuffer}.
+ * For example, can be used with a {@link StringBuilder}
+ * or {@link StringBuffer}.
*
*
* @since 2.7
(commons-io) branch master updated: Javadoc
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 6c338fd7 Javadoc
6c338fd7 is described below
commit 6c338fd78a97428b815fa169421b8c7973431ced
Author: Gary Gregory
AuthorDate: Sat Nov 11 16:14:10 2023 -0500
Javadoc
---
.../java/org/apache/commons/io/monitor/FileAlterationMonitorTest.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git
a/src/test/java/org/apache/commons/io/monitor/FileAlterationMonitorTest.java
b/src/test/java/org/apache/commons/io/monitor/FileAlterationMonitorTest.java
index 9399bf17..637a6852 100644
--- a/src/test/java/org/apache/commons/io/monitor/FileAlterationMonitorTest.java
+++ b/src/test/java/org/apache/commons/io/monitor/FileAlterationMonitorTest.java
@@ -41,7 +41,7 @@ import org.junit.jupiter.api.Test;
public class FileAlterationMonitorTest extends AbstractMonitorTest {
/**
- * Construct a new test case.
+ * Constructs a new test case.
*
*/
public FileAlterationMonitorTest() {
[commons-io] branch master updated: Javadoc
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 20d8a001 Javadoc
20d8a001 is described below
commit 20d8a001fe871d5a30ae07c7aea8b70f8704ff8b
Author: Gary Gregory
AuthorDate: Wed Oct 11 07:40:56 2023 -0400
Javadoc
Make private static classes final
---
src/main/java/org/apache/commons/io/IOIndexedException.java | 3 +++
.../org/apache/commons/io/comparator/CompositeFileComparator.java | 3 +++
src/main/java/org/apache/commons/io/file/PathUtils.java | 6 +++---
src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java| 4 ++--
.../java/org/apache/commons/io/input/ReversedLinesFileReader.java | 3 +++
src/test/java/org/apache/commons/io/DemuxInputStreamTest.java | 4 ++--
src/test/java/org/apache/commons/io/DirectoryWalkerTest.java| 4 ++--
.../java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java| 2 +-
src/test/java/org/apache/commons/io/function/IOBaseStreamTest.java | 4 ++--
src/test/java/org/apache/commons/io/function/IOFunctionTest.java| 2 +-
src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java | 2 +-
.../apache/commons/io/input/ClassLoaderObjectInputStreamTest.java | 2 +-
.../java/org/apache/commons/io/input/MarkShieldInputStreamTest.java | 2 +-
.../java/org/apache/commons/io/input/ObservableInputStreamTest.java | 4 ++--
src/test/java/org/apache/commons/io/input/ProxyReaderTest.java | 4 ++--
src/test/java/org/apache/commons/io/input/TailerTest.java | 4 ++--
.../org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java | 2 +-
.../compatibility/XmlStreamReaderUtilitiesCompatibilityTest.java| 2 +-
.../org/apache/commons/io/output/ByteArrayOutputStreamTest.java | 4 ++--
19 files changed, 35 insertions(+), 26 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOIndexedException.java
b/src/main/java/org/apache/commons/io/IOIndexedException.java
index 9a85328e..1893509f 100644
--- a/src/main/java/org/apache/commons/io/IOIndexedException.java
+++ b/src/main/java/org/apache/commons/io/IOIndexedException.java
@@ -42,6 +42,9 @@ public class IOIndexedException extends IOException {
return String.format("%s #%,d: %s", name, index, msg);
}
+/**
+ * Index.
+ */
private final int index;
/**
diff --git
a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
index 0f57a833..0e264341 100644
---
a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
+++
b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
@@ -48,6 +48,9 @@ public class CompositeFileComparator extends
AbstractFileComparator implements S
private static final Comparator[] EMPTY_COMPARATOR_ARRAY = {};
private static final long serialVersionUID = -2224170307287243428L;
+/**
+ * Delegates.
+ */
private final Comparator[] delegates;
/**
diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java
b/src/main/java/org/apache/commons/io/file/PathUtils.java
index 71ab166e..d85fdb67 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -90,7 +90,7 @@ public final class PathUtils {
* Private worker/holder that computes and tracks relative path names and
their equality. We reuse the sorted relative
* lists when comparing directories.
*/
-private static class RelativeSortedPaths {
+private static final class RelativeSortedPaths {
final boolean equals;
// final List relativeDirList1; // might need later?
@@ -365,7 +365,7 @@ public final class PathUtils {
* Creates the parent directories for the given {@code path}.
*
* If the parent directory already exists, then return it.
- *
+ *
*
* @param path The path to a file (or directory).
* @param attrs An optional list of file attributes to set atomically when
creating the directories.
@@ -381,7 +381,7 @@ public final class PathUtils {
* Creates the parent directories for the given {@code path}.
*
* If the parent directory already exists, then return it.
- *
+ *
*
* @param path The path to a file (or directory).
* @param linkOption A {@link LinkOption} or null.
diff --git a/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
b/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
index fc334e96..72b1b1e8 100644
--- a/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
+++ b/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
@@ -38,7 +38,7 @@ class ByteBufferCleaner {
[commons-io] branch master updated: Javadoc
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 f3b44601 Javadoc
f3b44601 is described below
commit f3b44601abf9b79ba90780b963b4b8f8548bd9b1
Author: Gary Gregory
AuthorDate: Tue Oct 10 09:47:59 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/StreamIterator.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/StreamIterator.java
b/src/main/java/org/apache/commons/io/StreamIterator.java
index a77a9f7b..a1ed9c37 100644
--- a/src/main/java/org/apache/commons/io/StreamIterator.java
+++ b/src/main/java/org/apache/commons/io/StreamIterator.java
@@ -30,7 +30,7 @@ import java.util.stream.Stream;
*
*
* @param The {@link Stream} and {@link Iterator} type.
- * @since 2.9.0
+ * @since 2.15.0
*/
public final class StreamIterator implements Iterator, AutoCloseable {
[commons-io] branch master updated: Javadoc
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 8bee3643 Javadoc
8bee3643 is described below
commit 8bee364340a1df8337d341aad531d4173e277b6c
Author: Gary Gregory
AuthorDate: Tue Oct 10 08:29:48 2023 -0400
Javadoc
StreamIterator implements AutoCloseable to match Stream.
Stream extends BaseStream which implements AutoCloseable.
---
.../java/org/apache/commons/io/StreamIterator.java | 18 +-
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/StreamIterator.java
b/src/main/java/org/apache/commons/io/StreamIterator.java
index a7491343..e9b3226f 100644
--- a/src/main/java/org/apache/commons/io/StreamIterator.java
+++ b/src/main/java/org/apache/commons/io/StreamIterator.java
@@ -17,29 +17,28 @@
package org.apache.commons.io;
-import java.io.Closeable;
import java.util.Iterator;
import java.util.Objects;
import java.util.stream.Stream;
/**
- * Wraps and presents a {@link Stream} as an {@link AutoCloseable} {@link
Iterator} resource that automatically closes itself when reaching the end of
stream.
+ * Wraps and presents a {@link Stream} as a {@link AutoCloseable} {@link
Iterator} resource that automatically closes itself when reaching the end of
stream.
*
* Warning
*
- * In order to close the stream, the call site MUST either close the stream it
allocated OR call the iterator until the end.
+ * In order to close the stream, the call site MUST either close the stream it
allocated OR call this iterator until the end.
*
*
* @param The {@link Stream} and {@link Iterator} type.
* @since 2.9.0
*/
-final class StreamIterator implements Iterator, Closeable {
+final class StreamIterator implements Iterator, AutoCloseable {
/**
* Wraps and presents a stream as a closable resource that automatically
closes itself when reaching the end of stream.
* Warning
*
- * In order to close the stream, the call site MUST either close the
stream it allocated OR call the iterator until the end.
+ * In order to close the stream, the call site MUST either close the
stream it allocated OR call this iterator until the end.
*
*
* @param The stream and iterator type.
@@ -50,10 +49,19 @@ final class StreamIterator implements Iterator,
Closeable {
return new StreamIterator<>(stream);
}
+/**
+ * The given stream's Iterator.
+ */
private final Iterator iterator;
+/**
+ * The given stream.
+ */
private final Stream stream;
+/**
+ * Whether {@link #close()} has been called.
+ */
private boolean closed;
private StreamIterator(final Stream stream) {
[commons-io] branch master updated: [Javadoc] IOUtils#contentEquals does not throw NullPointerException #496.
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 f59c8752 [Javadoc] IOUtils#contentEquals does not throw NullPointerException #496. f59c8752 is described below commit f59c87524acbba36dea84c0cbd4683f061695199 Author: Gary Gregory AuthorDate: Sun Oct 8 11:54:05 2023 -0400 [Javadoc] IOUtils#contentEquals does not throw NullPointerException #496. --- src/changes/changes.xml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 0f6177ce..20ce3cba 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -91,6 +91,9 @@ The type attribute can be add,update,fix,remove. Remove unused test code #494. + +[Javadoc] IOUtils#contentEquals does not throw NullPointerException #496. + Add org.apache.commons.io.channels.FileChannels.
[commons-io] branch master updated: Javadoc
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 877b9e3f Javadoc
877b9e3f is described below
commit 877b9e3f5e553f8ad988b89b8adb6b93fa97a964
Author: Gary Gregory
AuthorDate: Thu Oct 5 08:14:54 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/StreamIterator.java | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/StreamIterator.java
b/src/main/java/org/apache/commons/io/StreamIterator.java
index fe086c98..a7491343 100644
--- a/src/main/java/org/apache/commons/io/StreamIterator.java
+++ b/src/main/java/org/apache/commons/io/StreamIterator.java
@@ -23,13 +23,14 @@ import java.util.Objects;
import java.util.stream.Stream;
/**
- * Wraps and presents a stream as a closable {@link Iterator} resource that
automatically closes itself when reaching the end of stream.
+ * Wraps and presents a {@link Stream} as an {@link AutoCloseable} {@link
Iterator} resource that automatically closes itself when reaching the end of
stream.
+ *
* Warning
*
* In order to close the stream, the call site MUST either close the stream it
allocated OR call the iterator until the end.
*
*
- * @param The stream and iterator type.
+ * @param The {@link Stream} and {@link Iterator} type.
* @since 2.9.0
*/
final class StreamIterator implements Iterator, Closeable {
[commons-io] branch master updated: Javadoc
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 6f4089ec Javadoc
6f4089ec is described below
commit 6f4089eccd2632efc9e97162ae8ede8d43f2c4b6
Author: Gary Gregory
AuthorDate: Sat Sep 30 17:50:21 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/FileUtils.java | 8
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index e9ad8a6a..3cd8ce76 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1989,7 +1989,7 @@ public class FileUtils {
*
*
* @param directory the directory to search in
- * @param extensions an array of extensions, ex. {"java","xml"}. If this
+ * @param extensions an array of extensions, for example, {"java","xml"}.
If this
* parameter is {@code null}, all files are returned.
* @param recursive if true all subdirectories are searched as well
* @return an iterator of java.io.File with the matching files
@@ -2232,7 +2232,7 @@ public class FileUtils {
* which match an array of extensions.
*
* @param directory the directory to search in
- * @param extensions an array of extensions, ex. {"java","xml"}. If this
+ * @param extensions an array of extensions, for example, {"java","xml"}.
If this
* parameter is {@code null}, all files are returned.
* @param recursive if true all subdirectories are searched as well
* @return a collection of java.io.File with the matching files
@@ -2970,8 +2970,8 @@ public class FileUtils {
*
* @param directory the directory to search in
* @param recursive if true all subdirectories are searched as well
- * @param extensions an array of extensions, ex. {"java","xml"}. If this
parameter is {@code null}, all files are returned.
- * @return an iterator of java.io.File with the matching files
+ * @param extensions an array of extensions, for example, {"java","xml"}.
If this parameter is {@code null}, all files are returned.
+ * @return a Stream of {@link File} for matching files.
* @throws IOException if an I/O error is thrown when accessing the
starting file.
* @since 2.9.0
*/
[commons-io] branch master updated: Javadoc
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 3c36b08a Javadoc
3c36b08a is described below
commit 3c36b08a449da579bd86d6b0c148022ba62de4eb
Author: Gary Gregory
AuthorDate: Sat Sep 30 09:39:55 2023 -0400
Javadoc
Better wording
---
src/main/java/org/apache/commons/io/CopyUtils.java| 2 +-
src/main/java/org/apache/commons/io/EndianUtils.java | 2 +-
src/main/java/org/apache/commons/io/FileUtils.java| 2 +-
src/main/java/org/apache/commons/io/FilenameUtils.java| 2 +-
src/main/java/org/apache/commons/io/HexDump.java | 2 +-
src/main/java/org/apache/commons/io/IOUtils.java | 2 +-
src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java | 2 +-
7 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/CopyUtils.java
b/src/main/java/org/apache/commons/io/CopyUtils.java
index b7e7829e..da01a987 100644
--- a/src/main/java/org/apache/commons/io/CopyUtils.java
+++ b/src/main/java/org/apache/commons/io/CopyUtils.java
@@ -103,7 +103,7 @@ import java.nio.charset.Charset;
* method variants to specify the encoding, each row may
* correspond to up to 2 methods.
*
- * Origin of code: Excalibur.
+ * Provenance: Excalibur.
*
* @deprecated Use IOUtils. Will be removed in 3.0.
* Methods renamed to IOUtils.write() or IOUtils.copy().
diff --git a/src/main/java/org/apache/commons/io/EndianUtils.java
b/src/main/java/org/apache/commons/io/EndianUtils.java
index acc95319..83c2ce25 100644
--- a/src/main/java/org/apache/commons/io/EndianUtils.java
+++ b/src/main/java/org/apache/commons/io/EndianUtils.java
@@ -34,7 +34,7 @@ import java.io.OutputStream;
* This class helps you solve this incompatibility.
*
*
- * Origin of code: Excalibur
+ * Provenance: Excalibur
*
*
* @see org.apache.commons.io.input.SwappedDataInputStream
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index edf3da86..e9ad8a6a 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -109,7 +109,7 @@ import org.apache.commons.io.function.Uncheck;
* {@link SecurityException} are not documented in the Javadoc.
*
*
- * Origin of code: Excalibur, Alexandria, Commons-Utils
+ * Provenance: Excalibur, Alexandria, Commons-Utils
*
*/
public class FileUtils {
diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java
b/src/main/java/org/apache/commons/io/FilenameUtils.java
index 09c62f71..a17006a8 100644
--- a/src/main/java/org/apache/commons/io/FilenameUtils.java
+++ b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -90,7 +90,7 @@ import java.util.stream.Stream;
* currently running on.
*
*
- * Origin of code: Excalibur, Alexandria, Tomcat, Commons-Utils.
+ * Provenance: Excalibur, Alexandria, Tomcat, Commons-Utils.
*
*
* @since 1.1
diff --git a/src/main/java/org/apache/commons/io/HexDump.java
b/src/main/java/org/apache/commons/io/HexDump.java
index d7e5abdc..0a53e3d6 100644
--- a/src/main/java/org/apache/commons/io/HexDump.java
+++ b/src/main/java/org/apache/commons/io/HexDump.java
@@ -31,7 +31,7 @@ import org.apache.commons.io.output.CloseShieldOutputStream;
* in hexadecimal form.
*
*
- * Origin of code: POI.
+ * Provenance: POI.
*
*/
public class HexDump {
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index b6b6f137..6d1ebe7e 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -118,7 +118,7 @@ import
org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream;
* closing streams after use.
*
*
- * Origin of code: Excalibur.
+ * Provenance: Excalibur.
*
*/
public class IOUtils {
diff --git
a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
index 31600f58..9239b520 100644
--- a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.EndianUtils;
* DataInput for systems relying on little endian data formats. When read,
values will be changed from little endian to
* big endian formats for internal usage.
*
- * Origin of code: Avalon Excalibur (IO)
+ * Provenance: Avalon Excalibur (IO)
*
*/
public class SwappedDataInputStream extends ProxyInputStream implements
DataInput {
[commons-io] branch master updated: Javadoc
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 72b1f88f Javadoc
72b1f88f is described below
commit 72b1f88fb722def136ce87c9b2bfdd3c9126bb3d
Author: Gary Gregory
AuthorDate: Mon Jul 24 08:04:20 2023 -0400
Javadoc
---
src/changes/changes.xml| 5 -
.../org/apache/commons/io/input/XmlStreamReader.java | 10 +-
.../commons/io/input/XmlStreamReaderUtilitiesTest.java | 2 +-
.../io/input/compatibility/XmlStreamReader.java| 18 +-
4 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index c38afdbf..c3159c7a 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -53,7 +53,7 @@ The type attribute can be add,update,fix,remove.
ReaderInputStream.read() throws an exception instead of returning -1
when called again after returning -1.
-FileUtils.forceMkdirParent() Javadoc is likely incorrect.
+FileUtils.forceMkdirParent() Javadoc is incorrect.
[StepSecurity] ci: Harden GitHub Actions #461.
@@ -61,6 +61,9 @@ The type attribute can be add,update,fix,remove.
MagicNumberFileFilter.accept(Path, BasicFileAttributes) doesn't its
byteOffset before reading.
+
+Javadoc improvements.
+
Add DeferredFileOutputStream.getPath().
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
index 1e0c2f4a..550af9ee 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -208,7 +208,7 @@ public class XmlStreamReader extends Reader {
private static final String RAW_EX_2 = "Illegal encoding, BOM [{0}] XML
guess [{1}] XML prolog [{2}] unknown BOM";
-private static final String HTTP_EX_1 = "Illegal encoding, CT-MIME [{0}]
CT-Enc [{1}] BOM [{2}] XML guess [{3}] XML prolog [{4}], BOM must be NULL";
+private static final String HTTP_EX_1 = "Illegal encoding, CT-MIME [{0}]
CT-Enc [{1}] BOM [{2}] XML guess [{3}] XML prolog [{4}], BOM must be null";
private static final String HTTP_EX_2 = "Illegal encoding, CT-MIME [{0}]
CT-Enc [{1}] BOM [{2}] XML guess [{3}] XML prolog [{4}], encoding mismatch";
@@ -225,7 +225,7 @@ public class XmlStreamReader extends Reader {
}
/**
- * Gets the charset parameter value, NULL if not present, NULL if
httpContentType is NULL.
+ * Gets the charset parameter value, {@code null} if not present, {@code
null} if httpContentType is {@code null}.
*
* @param httpContentType the HTTP content type
* @return The content type encoding (upcased)
@@ -245,7 +245,7 @@ public class XmlStreamReader extends Reader {
}
/**
- * Gets the MIME type or NULL if httpContentType is NULL.
+ * Gets the MIME type or {@code null} if httpContentType is {@code null}.
*
* @param httpContentType the HTTP content type
* @return The mime content type
@@ -265,7 +265,7 @@ public class XmlStreamReader extends Reader {
}
/**
- * Gets the encoding declared in the , NULL if none.
+ * Gets the encoding declared in the , {@code null} if
none.
*
* @param inputStream InputStream to create the reader from.
* @param guessedEnc guessed encoding
@@ -855,7 +855,7 @@ public class XmlStreamReader extends Reader {
/**
* Gets the default encoding to use if none is set in HTTP content-type,
XML prolog and the rules based on content-type are not adequate.
*
- * If it is NULL the content-type based rules are used.
+ * If it is {@code null} the content-type based rules are used.
*
*
* @return the default encoding to use.
diff --git
a/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
b/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
index f4c2dee1..e2cd2e68 100644
---
a/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
+++
b/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
@@ -38,7 +38,7 @@ public class XmlStreamReaderUtilitiesTest {
}
private static final String RAWMGS1 = "encoding mismatch";
private static final String RAWMGS2 = "unknown BOM";
-private static final String HTTPMGS1 = "BOM must be NULL";
+private static final String HTTPMGS1 = "BOM must be null";
private static final String HTTPMGS2 = "encoding mismatch";
private static final String HTTPMGS3 = "Illegal MIME";
diff --git
a/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
[commons-io] branch master updated: Javadoc
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 0f3a88d0 Javadoc
0f3a88d0 is described below
commit 0f3a88d0e598962e94fa4dc36bdf382275c2b264
Author: Gary Gregory
AuthorDate: Mon Jul 10 07:01:03 2023 -0400
Javadoc
---
.../apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
index 7b3c036b..232e7186 100644
---
a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
+++
b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
@@ -146,7 +146,7 @@ public final class UnsynchronizedByteArrayOutputStream
extends AbstractByteArray
*
* @param size the initial size
* @throws IllegalArgumentException if size is negative
- * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}.
+ * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}. Will be private in 3.0.0.
*/
@Deprecated
public UnsynchronizedByteArrayOutputStream(final int size) {
[commons-io] branch master updated: Javadoc
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 746d28e2 Javadoc
746d28e2 is described below
commit 746d28e2850df47680e491c5226b1131e54336c2
Author: Gary Gregory
AuthorDate: Sat Jun 24 11:14:32 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/function/IOLongSupplier.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/function/IOLongSupplier.java
b/src/main/java/org/apache/commons/io/function/IOLongSupplier.java
index ff5181c8..0741654b 100644
--- a/src/main/java/org/apache/commons/io/function/IOLongSupplier.java
+++ b/src/main/java/org/apache/commons/io/function/IOLongSupplier.java
@@ -23,7 +23,7 @@ import java.util.function.LongSupplier;
import java.util.function.Supplier;
/**
- * Like {@link IOLongSupplier} but throws {@link IOException}.
+ * Like {@link LongSupplier} but throws {@link IOException}.
*
* @since 2.14.0
*/
[commons-io] branch master updated: Javadoc
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 8b9e574b Javadoc
8b9e574b is described below
commit 8b9e574becb51ec69be715bf9401403f9858b990
Author: Gary Gregory
AuthorDate: Fri Jun 2 14:51:07 2023 -0400
Javadoc
---
src/test/java/org/apache/commons/io/file/CountersTest.java | 3 +++
.../java/org/apache/commons/io/file/PathUtilsContentEqualsTest.java| 3 +++
2 files changed, 6 insertions(+)
diff --git a/src/test/java/org/apache/commons/io/file/CountersTest.java
b/src/test/java/org/apache/commons/io/file/CountersTest.java
index d386b699..a329ee13 100644
--- a/src/test/java/org/apache/commons/io/file/CountersTest.java
+++ b/src/test/java/org/apache/commons/io/file/CountersTest.java
@@ -26,6 +26,9 @@ import org.apache.commons.io.file.Counters.PathCounters;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
+/**
+ * Tests {@link Counter} and implementations.
+ */
public class CountersTest extends TestArguments {
@ParameterizedTest
diff --git
a/src/test/java/org/apache/commons/io/file/PathUtilsContentEqualsTest.java
b/src/test/java/org/apache/commons/io/file/PathUtilsContentEqualsTest.java
index 23347d67..13ea17f2 100644
--- a/src/test/java/org/apache/commons/io/file/PathUtilsContentEqualsTest.java
+++ b/src/test/java/org/apache/commons/io/file/PathUtilsContentEqualsTest.java
@@ -30,6 +30,9 @@ import java.nio.file.Paths;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
+/**
+ * Tests {@link PathUtils}.
+ */
public class PathUtilsContentEqualsTest {
@TempDir
[commons-io] branch master updated: Javadoc
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 faa09372 Javadoc
faa09372 is described below
commit faa09372493ee5f2533cbe2975c3845124d26535
Author: Gary Gregory
AuthorDate: Fri Jun 2 14:49:10 2023 -0400
Javadoc
---
.../org/apache/commons/io/comparator/CompositeFileComparatorTest.java | 2 +-
.../org/apache/commons/io/comparator/DefaultFileComparatorTest.java | 2 +-
.../org/apache/commons/io/comparator/DirectoryFileComparatorTest.java | 2 +-
.../org/apache/commons/io/comparator/ExtensionFileComparatorTest.java | 2 +-
.../apache/commons/io/comparator/LastModifiedFileComparatorTest.java| 2 +-
.../java/org/apache/commons/io/comparator/NameFileComparatorTest.java | 2 +-
.../java/org/apache/commons/io/comparator/PathFileComparatorTest.java | 2 +-
.../java/org/apache/commons/io/comparator/SizeFileComparatorTest.java | 2 +-
8 files changed, 8 insertions(+), 8 deletions(-)
diff --git
a/src/test/java/org/apache/commons/io/comparator/CompositeFileComparatorTest.java
b/src/test/java/org/apache/commons/io/comparator/CompositeFileComparatorTest.java
index 8585ec48..ad5ada43 100644
---
a/src/test/java/org/apache/commons/io/comparator/CompositeFileComparatorTest.java
+++
b/src/test/java/org/apache/commons/io/comparator/CompositeFileComparatorTest.java
@@ -32,7 +32,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Test case for {@link CompositeFileComparator}.
+ * Tests {@link CompositeFileComparator}.
*/
public class CompositeFileComparatorTest extends ComparatorAbstractTest {
diff --git
a/src/test/java/org/apache/commons/io/comparator/DefaultFileComparatorTest.java
b/src/test/java/org/apache/commons/io/comparator/DefaultFileComparatorTest.java
index d85f9deb..f5280977 100644
---
a/src/test/java/org/apache/commons/io/comparator/DefaultFileComparatorTest.java
+++
b/src/test/java/org/apache/commons/io/comparator/DefaultFileComparatorTest.java
@@ -21,7 +21,7 @@ import java.io.File;
import org.junit.jupiter.api.BeforeEach;
/**
- * Test case for {@link DefaultFileComparator}.
+ * Tests {@link DefaultFileComparator}.
*/
public class DefaultFileComparatorTest extends ComparatorAbstractTest {
diff --git
a/src/test/java/org/apache/commons/io/comparator/DirectoryFileComparatorTest.java
b/src/test/java/org/apache/commons/io/comparator/DirectoryFileComparatorTest.java
index 82d3f19b..18e36c85 100644
---
a/src/test/java/org/apache/commons/io/comparator/DirectoryFileComparatorTest.java
+++
b/src/test/java/org/apache/commons/io/comparator/DirectoryFileComparatorTest.java
@@ -23,7 +23,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Test case for {@link DirectoryFileComparator}.
+ * Tests {@link DirectoryFileComparator}.
*/
public class DirectoryFileComparatorTest extends ComparatorAbstractTest {
diff --git
a/src/test/java/org/apache/commons/io/comparator/ExtensionFileComparatorTest.java
b/src/test/java/org/apache/commons/io/comparator/ExtensionFileComparatorTest.java
index 86e32f11..6a6a505c 100644
---
a/src/test/java/org/apache/commons/io/comparator/ExtensionFileComparatorTest.java
+++
b/src/test/java/org/apache/commons/io/comparator/ExtensionFileComparatorTest.java
@@ -26,7 +26,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Test case for {@link ExtensionFileComparator}.
+ * Tests {@link ExtensionFileComparator}.
*/
public class ExtensionFileComparatorTest extends ComparatorAbstractTest {
diff --git
a/src/test/java/org/apache/commons/io/comparator/LastModifiedFileComparatorTest.java
b/src/test/java/org/apache/commons/io/comparator/LastModifiedFileComparatorTest.java
index 5ce2e5da..923588fd 100644
---
a/src/test/java/org/apache/commons/io/comparator/LastModifiedFileComparatorTest.java
+++
b/src/test/java/org/apache/commons/io/comparator/LastModifiedFileComparatorTest.java
@@ -26,7 +26,7 @@ import org.apache.commons.io.test.TestUtils;
import org.junit.jupiter.api.BeforeEach;
/**
- * Test case for {@link LastModifiedFileComparator}.
+ * Tests {@link LastModifiedFileComparator}.
*/
public class LastModifiedFileComparatorTest extends ComparatorAbstractTest {
diff --git
a/src/test/java/org/apache/commons/io/comparator/NameFileComparatorTest.java
b/src/test/java/org/apache/commons/io/comparator/NameFileComparatorTest.java
index 1d37095f..cfbfe549 100644
--- a/src/test/java/org/apache/commons/io/comparator/NameFileComparatorTest.java
+++ b/src/test/java/org/apache/commons/io/comparator/NameFileComparatorTest.java
@@ -26,7 +26,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Test case for {@link NameFileComparator}.
+ * Tests {@link NameFileComparator}.
*/
public
[commons-io] branch master updated: Javadoc
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 87da2aad Javadoc
87da2aad is described below
commit 87da2aad791c595843d26fe81e8fd1a760906ad1
Author: Gary Gregory
AuthorDate: Fri Jun 2 14:47:53 2023 -0400
Javadoc
---
src/test/java/org/apache/commons/io/ByteOrderParserTest.java | 3 +++
src/test/java/org/apache/commons/io/CopyUtilsTest.java| 2 +-
src/test/java/org/apache/commons/io/DemuxInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/DirectoryWalkerTest.java | 4 +---
src/test/java/org/apache/commons/io/EndianUtilsTest.java | 1 +
src/test/java/org/apache/commons/io/FileCleanerTest.java | 4 +---
src/test/java/org/apache/commons/io/FileCleaningTrackerTest.java | 4 +---
src/test/java/org/apache/commons/io/FileDeleteStrategyTest.java | 4 +---
src/test/java/org/apache/commons/io/FileSystemUtilsTest.java | 2 +-
src/test/java/org/apache/commons/io/FileUtilsCopyToFileTest.java | 2 +-
.../java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java | 3 +++
src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java | 2 +-
src/test/java/org/apache/commons/io/FileUtilsListFilesTest.java | 2 +-
src/test/java/org/apache/commons/io/FileUtilsTest.java| 4 +---
src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java | 2 +-
src/test/java/org/apache/commons/io/FilenameUtilsTest.java| 4 +---
src/test/java/org/apache/commons/io/FilenameUtilsWildcardTest.java| 3 +++
src/test/java/org/apache/commons/io/HexDumpTest.java | 2 +-
src/test/java/org/apache/commons/io/IOExceptionWithCauseTest.java | 2 +-
src/test/java/org/apache/commons/io/IOIndexedExceptionTest.java | 2 --
src/test/java/org/apache/commons/io/IOUtilsCopyTest.java | 2 +-
src/test/java/org/apache/commons/io/TaggedIOExceptionTest.java| 2 +-
src/test/java/org/apache/commons/io/UncheckedIOExceptionsTest.java| 3 +--
23 files changed, 28 insertions(+), 33 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/ByteOrderParserTest.java
b/src/test/java/org/apache/commons/io/ByteOrderParserTest.java
index 268c9c33..80ab365f 100644
--- a/src/test/java/org/apache/commons/io/ByteOrderParserTest.java
+++ b/src/test/java/org/apache/commons/io/ByteOrderParserTest.java
@@ -23,6 +23,9 @@ import java.nio.ByteOrder;
import org.junit.jupiter.api.Test;
+/**
+ * Test for {@link ByteOrderParser}.
+ */
public class ByteOrderParserTest {
private ByteOrder parseByteOrder(final String value) {
diff --git a/src/test/java/org/apache/commons/io/CopyUtilsTest.java
b/src/test/java/org/apache/commons/io/CopyUtilsTest.java
index 51d96b90..e0bab26a 100644
--- a/src/test/java/org/apache/commons/io/CopyUtilsTest.java
+++ b/src/test/java/org/apache/commons/io/CopyUtilsTest.java
@@ -37,7 +37,7 @@ import org.junit.jupiter.api.Test;
@SuppressWarnings("deprecation") // these are test cases for the deprecated
CopyUtils
/**
- * JUnit tests for CopyUtils.
+ * Test for {@link CopyUtils}.
*
* @see CopyUtils
*/
diff --git a/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
b/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
index dd71814b..6872bc54 100644
--- a/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java
@@ -33,7 +33,7 @@ import org.apache.commons.io.test.TestUtils;
import org.junit.jupiter.api.Test;
/**
- * Basic unit tests for the multiplexing streams.
+ * Tests {@link DemuxInputStream}.
*/
public class DemuxInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
index b9ca1d23..b90a7ed2 100644
--- a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
+++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
@@ -35,9 +35,7 @@ import org.apache.commons.io.filefilter.NameFileFilter;
import org.junit.jupiter.api.Test;
/**
- * This is used to test DirectoryWalker for correctness.
- *
- * @see DirectoryWalker
+ * Tests {@link DirectoryWalker}.
*/
public class DirectoryWalkerTest {
diff --git a/src/test/java/org/apache/commons/io/EndianUtilsTest.java
b/src/test/java/org/apache/commons/io/EndianUtilsTest.java
index 52fbaedb..79df0c66 100644
--- a/src/test/java/org/apache/commons/io/EndianUtilsTest.java
+++ b/src/test/java/org/apache/commons/io/EndianUtilsTest.java
@@ -27,6 +27,7 @@ import java.io.IOException;
import org.junit.jupiter.api.Test;
/**
+ * Tests {@link EndianUtils}.
*/
public class EndianUtilsTest {
diff --git a/src/test/java/org/apache/commons/io/FileCleanerTest.java
[commons-io] branch master updated: Javadoc
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 80118e50 Javadoc
80118e50 is described below
commit 80118e507787bdb80def60f807e37003ab9fb65e
Author: Gary Gregory
AuthorDate: Thu Jun 1 13:46:24 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/build/AbstractSupplier.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
index f35c9bca..bfbeabad 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
@@ -20,7 +20,7 @@ package org.apache.commons.io.build;
import org.apache.commons.io.function.IOSupplier;
/**
- * Abstracts supplying a typed instance of {@code T}. Use to implement the
builder pattern.
+ * Abstracts supplying an instance of {@code T}. Use to implement the builder
pattern.
*
* @param the type of instances to build.
* @param the type of builder subclass.
[commons-io] branch master updated: Javadoc
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 2628fd32 Javadoc
2628fd32 is described below
commit 2628fd32224f4ac6394fcc845bd898533c45a061
Author: Gary Gregory
AuthorDate: Thu Jun 1 13:46:00 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
index c38a045f..bc79dba5 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
@@ -37,7 +37,7 @@ import org.apache.commons.io.build.AbstractOrigin.URIOrigin;
import org.apache.commons.io.build.AbstractOrigin.WriterOrigin;
/**
- * Abstracts building a typed instance of {@code T}.
+ * Abstracts building an instance of {@code T}.
*
* @param the type of instances to build.
* @param the type of builder subclass.
[commons-io] branch master updated: Javadoc
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 2365a1ed Javadoc
2365a1ed is described below
commit 2365a1ed44046f13d8ee51b930ea9a9e8ec209dd
Author: Gary Gregory
AuthorDate: Wed May 31 17:08:06 2023 -0400
Javadoc
---
src/test/java/org/apache/commons/io/RandomAccessFilesTest.java | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/test/java/org/apache/commons/io/RandomAccessFilesTest.java
b/src/test/java/org/apache/commons/io/RandomAccessFilesTest.java
index dc5ee654..d3873599 100644
--- a/src/test/java/org/apache/commons/io/RandomAccessFilesTest.java
+++ b/src/test/java/org/apache/commons/io/RandomAccessFilesTest.java
@@ -26,6 +26,9 @@ import java.io.RandomAccessFile;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link RandomAccessFiles}.
+ */
public class RandomAccessFilesTest {
protected static final String FILE_RES_RO =
"/org/apache/commons/io/test-file-20byteslength.bin";
[commons-io] branch master updated: Javadoc
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 bebf1ffa Javadoc
bebf1ffa is described below
commit bebf1ffa3906b560bc9f27f5606c77ee9153ebf9
Author: Gary Gregory
AuthorDate: Wed May 31 17:06:44 2023 -0400
Javadoc
---
.../commons/io/filefilter/WildcardFileFilter.java | 12 +-
.../commons/io/input/AutoCloseInputStream.java | 2 +-
.../apache/commons/io/input/BOMInputStream.java| 8 +++
.../io/input/BufferedFileChannelInputStream.java | 8 +++
.../commons/io/input/CharSequenceInputStream.java | 8 +++
.../input/MessageDigestCalculatingInputStream.java | 6 ++---
.../apache/commons/io/input/QueueInputStream.java | 2 +-
.../io/input/RandomAccessFileInputStream.java | 4 ++--
.../commons/io/input/ReadAheadInputStream.java | 4 ++--
.../java/org/apache/commons/io/input/Tailer.java | 28 +++---
.../input/UnsynchronizedByteArrayInputStream.java | 6 ++---
.../apache/commons/io/input/XmlStreamReader.java | 16 ++---
.../commons/io/output/ChunkedOutputStream.java | 4 ++--
.../io/output/DeferredFileOutputStream.java| 8 +++
.../commons/io/output/FileWriterWithEncoding.java | 24 +--
.../commons/io/output/LockableFileWriter.java | 18 +++---
.../UnsynchronizedByteArrayOutputStream.java | 4 ++--
.../commons/io/output/WriterOutputStream.java | 14 +--
.../apache/commons/io/output/XmlStreamWriter.java | 8 +++
19 files changed, 92 insertions(+), 92 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
index e3907d19..0b21e7a0 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
@@ -177,7 +177,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
* @param wildcards the list of wildcards to match, not null
* @throws IllegalArgumentException if the pattern list is null
* @throws ClassCastException if the list does not contain Strings
- * @deprecated Use {@link #builder()} and {@link Builder#get()}
+ * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}
*/
@Deprecated
public WildcardFileFilter(final List wildcards) {
@@ -191,7 +191,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
* @param ioCasehow to handle case sensitivity, null means
case-sensitive
* @throws IllegalArgumentException if the pattern list is null
* @throws ClassCastException if the list does not contain Strings
- * @deprecated Use {@link #builder()} and {@link Builder#get()}
+ * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}
*/
@Deprecated
public WildcardFileFilter(final List wildcards, final IOCase
ioCase) {
@@ -203,7 +203,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
*
* @param wildcard the wildcard to match
* @throws IllegalArgumentException if the pattern is null
- * @deprecated Use {@link #builder()} and {@link Builder#get()}
+ * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}
*/
@Deprecated
public WildcardFileFilter(final String wildcard) {
@@ -215,7 +215,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
*
* @param wildcards the array of wildcards to match
* @throws NullPointerException if the pattern array is null
- * @deprecated Use {@link #builder()} and {@link Builder#get()}
+ * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}
*/
@Deprecated
public WildcardFileFilter(final String... wildcards) {
@@ -228,7 +228,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
* @param wildcard the wildcard to match, not null
* @param ioCase how to handle case sensitivity, null means
case-sensitive
* @throws NullPointerException if the pattern is null
- * @deprecated Use {@link #builder()} and {@link Builder#get()}
+ * @deprecated Use {@link #builder()}, {@link Builder}, and {@link
Builder#get()}
*/
@Deprecated
public WildcardFileFilter(final String wildcard, final IOCase ioCase) {
@@ -241,7 +241,7 @@ public class WildcardFileFilter extends AbstractFileFilter
implements Serializab
* @param wildcards the array of wildcards to match, not null
* @param ioCasehow to handle case sensitivity, null means
case-sensitive
* @throws
[commons-io] branch master updated: Javadoc
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 e5a34caa Javadoc
e5a34caa is described below
commit e5a34caa99bdb5c4bb5aa0875433d1e78bc387b0
Author: Gary Gregory
AuthorDate: Wed May 31 14:50:18 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/RandomAccessFileMode.java | 12 ++--
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
index f928e587..bb2c1236 100644
--- a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
+++ b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
@@ -29,24 +29,24 @@ import java.nio.file.Path;
public enum RandomAccessFileMode {
/**
- * Mode "r" opens for reading only.
+ * Mode {@code "r"} opens for reading only.
*/
READ_ONLY("r"),
/**
- * Mode "rw" opens for reading and writing.
+ * Mode {@code "rw"} opens for reading and writing.
*/
READ_WRITE("rw"),
/**
- * Mode "rws" opens for reading and writing, as with "rw", and also
require that every update to the file's content or
- * metadata be written synchronously to the underlying storage device.
+ * Mode {@code "rws"} opens for reading and writing, as with {@code "rw"},
and also require that every update to the file's content or metadata be written
+ * synchronously to the underlying storage device.
*/
READ_WRITE_SYNC_ALL("rws"),
/**
- * Mode "rwd" open for reading and writing, as with "rw", and also require
that every update to the file's content be
- * written synchronously to the underlying storage device.
+ * Mode {@code "rwd"} open for reading and writing, as with {@code "rw"},
and also require that every update to the file's content be written
synchronously
+ * to the underlying storage device.
*/
READ_WRITE_SYNC_CONTENT("rwd");
[commons-io] branch master updated: Javadoc
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 c5fead72 Javadoc
c5fead72 is described below
commit c5fead728420d626251dffe7756ef9897a299063
Author: Gary Gregory
AuthorDate: Wed May 31 11:27:24 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index abc528ee..0e6cf2bb 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -122,7 +122,7 @@ public class BOMInputStream extends ProxyInputStream {
private static final ByteOrderMark[] DEFAULT = { ByteOrderMark.UTF_8 };
-// for test access
+/** For test access. */
static ByteOrderMark getDefaultByteOrderMark() {
return DEFAULT[0];
}
[commons-io] branch master updated: Javadoc
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 f64dd1d4 Javadoc
f64dd1d4 is described below
commit f64dd1d46dbe52e8c14a7846fd060d38bef2589f
Author: Gary Gregory
AuthorDate: Fri May 19 21:12:57 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/build/AbstractOrigin.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
index a51176f6..6624bfb6 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
@@ -47,7 +47,7 @@ import java.util.Objects;
public abstract class AbstractOrigin>
extends AbstractSupplier {
/**
- * A {@link File} origin.
+ * A {@code byte[]} origin.
*/
public static class ByteArrayOrigin extends AbstractOrigin {
[commons-io] branch master updated: Javadoc
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 18331dbc Javadoc
18331dbc is described below
commit 18331dbcb6e401f7a30d5bdb9441610ca377dd41
Author: Gary Gregory
AuthorDate: Fri May 19 09:42:28 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 1e301f35..e48b2c18 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -143,7 +143,7 @@ public class BOMInputStream extends ProxyInputStream {
* {@link UnsupportedOperationException}.
*
*
- * @throws UnsupportedOperationException if the origin provide an
InputStream.
+ * @throws UnsupportedOperationException if the origin cannot provide
an InputStream.
* @see AbstractOrigin#getInputStream(OpenOption...)
*/
@SuppressWarnings("resource")
[commons-io] branch master updated: Javadoc
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 57eb3004 Javadoc
57eb3004 is described below
commit 57eb3004feee23b99e373840c33142f69c3f6281
Author: Gary Gregory
AuthorDate: Fri May 19 09:40:38 2023 -0400
Javadoc
---
.../org/apache/commons/io/input/BOMInputStream.java| 18 +-
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 7aa33691..b2492b99 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -20,6 +20,7 @@ import static org.apache.commons.io.IOUtils.EOF;
import java.io.IOException;
import java.io.InputStream;
+import java.nio.file.OpenOption;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
@@ -27,6 +28,7 @@ import java.util.Objects;
import org.apache.commons.io.ByteOrderMark;
import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.build.AbstractOrigin;
import org.apache.commons.io.build.AbstractStreamBuilder;
/**
@@ -133,8 +135,16 @@ public class BOMInputStream extends ProxyInputStream {
/**
* Constructs a new instance.
+ *
+ * This builder use the aspects InputStream, include, and
ByteOrderMark[].
+ *
+ *
+ * You must provide an origin that can be converted to an InputStream
by this builder, otherwise, this call will throw an
+ * {@link UnsupportedOperationException}.
+ *
*
- * @throws UnsupportedOperationException if the origin cannot be
converted to an InputStream.
+ * @throws UnsupportedOperationException if the origin provide an
InputStream.
+ * @see AbstractOrigin#getInputStream(OpenOption...)
*/
@SuppressWarnings("resource")
@Override
@@ -144,6 +154,9 @@ public class BOMInputStream extends ProxyInputStream {
/**
* Sets the ByteOrderMarks to detect and optionally exclude.
+ *
+ * The default is {@link ByteOrderMark#UTF_8}.
+ *
*
* @param byteOrderMarks the ByteOrderMarks to detect and optionally
exclude.
* @return this
@@ -155,6 +168,9 @@ public class BOMInputStream extends ProxyInputStream {
/**
* Sets whether to include the UTF-8 BOM (true) or to exclude it
(false).
+ *
+ * The default is false.
+ *
*
* @param include true to include the UTF-8 BOM or false to exclude
it. return this;
* @return this
[commons-io] branch master updated: Javadoc
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 5db9871c Javadoc
5db9871c is described below
commit 5db9871cc2f27e84f8f5d3a501876e3ff5c33ba6
Author: Gary Gregory
AuthorDate: Fri May 19 08:40:12 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/ByteOrderMark.java | 58 +++---
1 file changed, 52 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java
b/src/main/java/org/apache/commons/io/ByteOrderMark.java
index 8762f9a0..2e4f0305 100644
--- a/src/main/java/org/apache/commons/io/ByteOrderMark.java
+++ b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -22,7 +22,17 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Byte Order Mark (BOM) representation - see {@link
org.apache.commons.io.input.BOMInputStream}.
+ * Byte Order Mark (BOM) representation. See {@link
org.apache.commons.io.input.BOMInputStream}.
+ *
+ * We define the follow BOM constants:
+ *
+ *
+ * {@link #UTF_16BE}
+ * {@link #UTF_16LE}
+ * {@link #UTF_32BE}
+ * {@link #UTF_32LE}
+ * {@link #UTF_8}
+ *
* Deprecating Serialization
*
* Serialization is deprecated and will be removed in 3.0.
@@ -38,17 +48,47 @@ public class ByteOrderMark implements Serializable {
private static final long serialVersionUID = 1L;
-/** UTF-8 BOM. */
+/**
+ * UTF-8 BOM.
+ *
+ * This BOM is:
+ *
+ *
+ * 0xEF 0xBB 0xBF
+ *
+ */
public static final ByteOrderMark UTF_8 = new
ByteOrderMark(StandardCharsets.UTF_8.name(), 0xEF, 0xBB, 0xBF);
-/** UTF-16BE BOM (Big-Endian). */
+/**
+ * UTF-16BE BOM (Big-Endian).
+ *
+ * This BOM is:
+ *
+ *
+ * 0xFE 0xFF
+ *
+ */
public static final ByteOrderMark UTF_16BE = new
ByteOrderMark(StandardCharsets.UTF_16BE.name(), 0xFE, 0xFF);
-/** UTF-16LE BOM (Little-Endian). */
+/**
+ * UTF-16LE BOM (Little-Endian).
+ *
+ * This BOM is:
+ *
+ *
+ * 0xFF 0xFE
+ *
+ */
public static final ByteOrderMark UTF_16LE = new
ByteOrderMark(StandardCharsets.UTF_16LE.name(), 0xFF, 0xFE);
/**
* UTF-32BE BOM (Big-Endian).
+ *
+ * This BOM is:
+ *
+ *
+ * 0x00 0x00 0xFE 0xFF
+ *
*
* @since 2.2
*/
@@ -56,6 +96,12 @@ public class ByteOrderMark implements Serializable {
/**
* UTF-32LE BOM (Little-Endian).
+ *
+ * This BOM is:
+ *
+ *
+ * 0xFF 0xFE 0x00 0x00
+ *
*
* @since 2.2
*/
@@ -150,9 +196,9 @@ public class ByteOrderMark implements Serializable {
}
/**
- * Computes the hashcode for this BOM.
+ * Computes the hash code for this BOM.
*
- * @return the hashcode for this BOM.
+ * @return the hash code for this BOM.
* @see Object#hashCode()
*/
@Override
[commons-io] branch master updated: Javadoc
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 f03c2ace Javadoc
f03c2ace is described below
commit f03c2ace65d15d21b06d2ceea01dc84bf1f6feef
Author: Gary Gregory
AuthorDate: Thu May 18 17:45:54 2023 -0400
Javadoc
Sort members
---
.../commons/io/input/CharSequenceInputStream.java | 4 ++--
.../commons/io/input/MemoryMappedFileInputStream.java | 18 ++
.../org/apache/commons/io/input/ReaderInputStream.java | 5 -
.../io/input/UnsynchronizedBufferedInputStream.java| 5 -
.../apache/commons/io/output/WriterOutputStream.java | 5 -
src/test/java/org/apache/commons/io/FileUtilsTest.java | 16
src/test/java/org/apache/commons/io/IOUtilsTest.java | 14 +++---
7 files changed, 39 insertions(+), 28 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index b70d3cd9..f19ff33a 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -87,6 +87,8 @@ public class CharSequenceInputStream extends InputStream {
}
+private static final int NO_MARK = -1;
+
/**
* Constructs a new {@link Builder}.
*
@@ -97,8 +99,6 @@ public class CharSequenceInputStream extends InputStream {
return new Builder();
}
-private static final int NO_MARK = -1;
-
private final CharsetEncoder charsetEncoder;
private final CharBuffer cBuf;
private final ByteBuffer bBuf;
diff --git
a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
index 3622a501..20308a43 100644
--- a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
@@ -46,10 +46,11 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
* To build an instance, see {@link Builder}.
*
* {@code
- * BufferedInputStream s = new BufferedInputStream(new
GzipInputStream(MemoryMappedFileInputStream.builder()
- * .setPath(path)
- * .setBufferSize(256 * 1024)
- * .get()));}
+ * BufferedInputStream s = new BufferedInputStream(new GzipInputStream(
+ * MemoryMappedFileInputStream.builder()
+ * .setPath(path)
+ * .setBufferSize(256 * 1024)
+ * .get()));}
*
*
* should outperform:
@@ -58,10 +59,11 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
* new GzipInputStream(new MemoryMappedFileInputStream(path))
*
* {@code
- * GzipInputStream s = new
GzipInputStream(MemoryMappedFileInputStream.builder()
- * .setPath(path)
- * .setBufferSize(256 * 1024)
- * .get());}
+ * GzipInputStream s = new GzipInputStream(
+ * MemoryMappedFileInputStream.builder()
+ * .setPath(path)
+ * .setBufferSize(256 * 1024)
+ * .get());}
*
*
* @since 2.12.0
diff --git a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
index 63b7cf37..a78bd6f8 100644
--- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -55,7 +55,10 @@ import org.apache.commons.io.charset.CharsetEncoders;
* InputStream inputStream = ...
* Charset cs = ...
* InputStreamReader reader = new InputStreamReader(inputStream, cs);
- * ReaderInputStream in2 = new ReaderInputStream(reader, cs);
+ * ReaderInputStream in2 = ReaderInputStream.builder()
+ * .setReader(reader)
+ * .setCharset(cs)
+ * .get();
*
*
* {@link ReaderInputStream} implements the same transformation as {@link
java.io.OutputStreamWriter}, except that the control flow is reversed: both
classes
diff --git
a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
index e6f3d525..ad544368 100644
---
a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
@@ -39,7 +39,10 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*
*
*
- * UnsynchronizedBufferedInputStream buf = new
UnsynchronizedBufferedInputStream(new FileInputStream(file.java));
+ * UnsynchronizedBufferedInputStream s = new
UnsynchronizedBufferedInputStream.Builder().
+ * .setInputStream(new FileInputStream(file.java))
+ * .setBufferSize(8192)
+ * .get();
*
*
* Provenance: Apache Harmony and modified.
diff --git
[commons-io] branch master updated: Javadoc
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 8828e667 Javadoc
8828e667 is described below
commit 8828e667df823e2bf04e5035b414bc2f4b162a31
Author: Gary Gregory
AuthorDate: Thu May 18 17:33:29 2023 -0400
Javadoc
---
.../org/apache/commons/io/input/BOMInputStream.java | 14 ++
.../io/input/BufferedFileChannelInputStream.java| 4 ++--
.../commons/io/input/CharSequenceInputStream.java | 3 ++-
.../commons/io/input/MemoryMappedFileInputStream.java | 17 +
.../io/input/MessageDigestCalculatingInputStream.java | 4 ++--
.../org/apache/commons/io/input/QueueInputStream.java | 3 +--
.../commons/io/input/RandomAccessFileInputStream.java | 4 ++--
.../apache/commons/io/input/ReadAheadInputStream.java | 4 ++--
.../org/apache/commons/io/input/ReaderInputStream.java | 4 ++--
.../commons/io/input/ReversedLinesFileReader.java | 4 ++--
src/main/java/org/apache/commons/io/input/Tailer.java | 4 ++--
.../commons/io/input/UncheckedBufferedReader.java | 4 ++--
.../commons/io/input/UncheckedFilterInputStream.java| 4 ++--
.../apache/commons/io/input/UncheckedFilterReader.java | 4 ++--
.../io/input/UnsynchronizedBufferedInputStream.java | 4 ++--
.../io/input/UnsynchronizedByteArrayInputStream.java| 6 +++---
.../io/input/UnsynchronizedFilterInputStream.java | 4 ++--
.../org/apache/commons/io/input/XmlStreamReader.java| 3 +--
.../commons/io/output/DeferredFileOutputStream.java | 2 +-
.../commons/io/output/FileWriterWithEncoding.java | 5 +++--
.../apache/commons/io/output/LockableFileWriter.java| 4 ++--
.../commons/io/output/UncheckedFilterOutputStream.java | 4 ++--
.../apache/commons/io/output/UncheckedFilterWriter.java | 4 ++--
.../io/output/UnsynchronizedByteArrayOutputStream.java | 4 ++--
.../apache/commons/io/output/WriterOutputStream.java| 4 ++--
.../org/apache/commons/io/output/XmlStreamWriter.java | 4 ++--
26 files changed, 66 insertions(+), 59 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 7e45fe31..7aa33691 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -98,26 +98,24 @@ public class BOMInputStream extends ProxyInputStream {
/**
* Builds a new {@link BOMInputStream} instance.
- *
- * Using NIO
- *
+ *
+ * Using NIO
* {@code
* BOMInputStream s = BOMInputStream.builder()
* .setPath(Paths.get("MyFile.xml"))
* .setByteOrderMarks(ByteOrderMark.UTF_8)
* .setInclude(false)
- * .get()}
+ * .get();}
*
- *
- * Using IO
- *
+ * Using IO
* {@code
* BOMInputStream s = BOMInputStream.builder()
* .setFile(new File("MyFile.xml"))
* .setByteOrderMarks(ByteOrderMark.UTF_8)
* .setInclude(false)
- * .get()}
+ * .get();}
*
+ *
* @since 2.12.0
*/
public static class Builder extends AbstractStreamBuilder {
diff --git
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
index 2314ab40..a29e488d 100644
---
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
@@ -52,7 +52,7 @@ public final class BufferedFileChannelInputStream extends
InputStream {
* BufferedFileChannelInputStream s =
BufferedFileChannelInputStream.builder()
* .setFile(file)
* .setBufferSize(4096)
- * .get()}
+ * .get();}
*
*
* Using NIO Path:
@@ -62,7 +62,7 @@ public final class BufferedFileChannelInputStream extends
InputStream {
* BufferedFileChannelInputStream s =
BufferedFileChannelInputStream.builder()
* .setPath(path)
* .setBufferSize(4096)
- * .get()}
+ * .get();}
*
*
* @since 2.12.0
diff --git
a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index 1e503b31..b70d3cd9 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -55,8 +55,9 @@ public class CharSequenceInputStream extends InputStream {
* .setBufferSize(8192)
* .setCharSequence("String")
* .setCharsetEncoder(Charset.defaultCharset())
- * .get()}
+ * .get();}
*
+ *
* @since
[commons-io] branch master updated: Javadoc
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 92352a75 Javadoc
92352a75 is described below
commit 92352a75c0b85c93a083b4c9199e8cae0f050ee5
Author: Gary Gregory
AuthorDate: Thu May 18 17:16:23 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 0075caf7..7e45fe31 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -48,7 +48,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*
* To build an instance, see {@link Builder}.
*
- * Example 1 - Detect and exclude a UTF-8 BOM
+ * Example 1 - Detecting and excluding a UTF-8 BOM
*
*
* BOMInputStream bomIn = BOMInputStream.builder().setInputStream(in).get();
@@ -57,7 +57,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
* }
*
*
- * Example 2 - Detect a UTF-8 BOM (but don't exclude it)
+ * Example 2 - Detecting a UTF-8 BOM without excluding it
*
*
* boolean include = true;
@@ -70,7 +70,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
* }
*
*
- * Example 3 - Detect Multiple BOMs
+ * Example 3 - Detecting Multiple BOMs
*
*
* BOMInputStream bomIn = BOMInputStream.builder()
[commons-io] branch master updated: Javadoc
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 6cbfdca9 Javadoc
6cbfdca9 is described below
commit 6cbfdca9c228be416af8742d755cb910b2fabe32
Author: Gary Gregory
AuthorDate: Thu May 18 17:14:03 2023 -0400
Javadoc
---
.../org/apache/commons/io/input/BOMInputStream.java | 19 ++-
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 53e3d50c..0075caf7 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -98,17 +98,26 @@ public class BOMInputStream extends ProxyInputStream {
/**
* Builds a new {@link BOMInputStream} instance.
- *
- * For example:
- *
+ *
+ * Using NIO
+ *
* {@code
* BOMInputStream s = BOMInputStream.builder()
- * .setPath(path)
+ * .setPath(Paths.get("MyFile.xml"))
+ * .setByteOrderMarks(ByteOrderMark.UTF_8)
+ * .setInclude(false)
+ * .get()}
+ *
+ *
+ * Using IO
+ *
+ * {@code
+ * BOMInputStream s = BOMInputStream.builder()
+ * .setFile(new File("MyFile.xml"))
* .setByteOrderMarks(ByteOrderMark.UTF_8)
* .setInclude(false)
* .get()}
*
- *
* @since 2.12.0
*/
public static class Builder extends AbstractStreamBuilder {
[commons-io] branch master updated: Javadoc
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 b3408278 Javadoc
b3408278 is described below
commit b3408278f79cd107368364ffcd6dd329891fa226
Author: Gary Gregory
AuthorDate: Thu May 18 12:15:23 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 5 -
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 5f78335c..9e8b5284 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -61,7 +61,10 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*
*
* boolean include = true;
- * BOMInputStream bomIn =
BOMInputStream.builder().setInputStream(in).setInclude(include).get();
+ * BOMInputStream bomIn = BOMInputStream.builder()
+ * .setInputStream(in)
+ * .setInclude(include)
+ * .get();
* if (bomIn.hasBOM()) {
* // has a UTF-8 BOM
* }
[commons-io] branch master updated: Javadoc
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 cbdbe648 Javadoc
cbdbe648 is described below
commit cbdbe648e4cf615824e168f3946c2da68bc56929
Author: Gary Gregory
AuthorDate: Thu May 18 10:51:38 2023 -0400
Javadoc
Use varargs for
BOMInputStream.Builder.setByteOrderMarks(ByteOrderMark...)
---
.../commons/io/filefilter/WildcardFileFilter.java | 8 ++--
.../org/apache/commons/io/input/BOMInputStream.java| 18 ++
.../io/input/BufferedFileChannelInputStream.java | 3 +++
.../commons/io/input/MemoryMappedFileInputStream.java | 3 +++
.../io/input/MessageDigestCalculatingInputStream.java | 3 +++
.../org/apache/commons/io/input/QueueInputStream.java | 4 +++-
.../commons/io/input/RandomAccessFileInputStream.java | 4 +++-
.../apache/commons/io/input/ReadAheadInputStream.java | 3 +++
.../org/apache/commons/io/input/ReaderInputStream.java | 4 +++-
.../commons/io/input/ReversedLinesFileReader.java | 6 --
.../org/apache/commons/io/input/StringInputStream.java | 4 +++-
src/main/java/org/apache/commons/io/input/Tailer.java | 4 +++-
.../commons/io/input/UncheckedBufferedReader.java | 3 +++
.../commons/io/input/UncheckedFilterInputStream.java | 3 +++
.../apache/commons/io/input/UncheckedFilterReader.java | 3 +++
.../io/input/UnsynchronizedBufferedInputStream.java| 3 +++
.../io/input/UnsynchronizedByteArrayInputStream.java | 3 +++
.../io/input/UnsynchronizedFilterInputStream.java | 3 +++
.../org/apache/commons/io/input/XmlStreamReader.java | 3 +++
.../commons/io/output/DeferredFileOutputStream.java| 3 +++
.../commons/io/output/FileWriterWithEncoding.java | 3 +++
.../apache/commons/io/output/LockableFileWriter.java | 3 +++
.../commons/io/output/UncheckedFilterOutputStream.java | 3 +++
.../commons/io/output/UncheckedFilterWriter.java | 3 +++
.../io/output/UnsynchronizedByteArrayOutputStream.java | 3 +++
.../apache/commons/io/output/WriterOutputStream.java | 9 +++--
.../org/apache/commons/io/output/XmlStreamWriter.java | 6 --
27 files changed, 97 insertions(+), 21 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
index df337acb..4315183b 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
@@ -39,13 +39,16 @@ import org.apache.commons.io.build.AbstractSupplier;
* command lines. The check is case-sensitive by default. See {@link
FilenameUtils#wildcardMatchOnSystem(String,String)} for more information.
*
*
+ * To build an instance, see {@link Builder}.
+ *
+ *
* For example:
*
* Using Classic IO
*
*
* File dir = FileUtils.current();
- * FileFilter fileFilter = new WildcardFileFilter("*test*.java~*~");
+ * FileFilter fileFilter =
WildcardFileFilter.builder().setWildcards("*test*.java~*~").get();
* File[] files = dir.listFiles(fileFilter);
* for (String file : files) {
* System.out.println(file);
@@ -56,7 +59,8 @@ import org.apache.commons.io.build.AbstractSupplier;
*
*
* final Path dir = PathUtils.current();
- * final AccumulatorPathVisitor visitor =
AccumulatorPathVisitor.withLongCounters(new
WildcardFileFilter("*test*.java~*~"));
+ * final AccumulatorPathVisitor visitor =
AccumulatorPathVisitor.withLongCounters(
+ * WildcardFileFilter.builder().setWildcards("*test*.java~*~").get());
* //
* // Walk one dir
* Files.walkFileTree(dir, Collections.emptySet(), 1, visitor);
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 252803df..5f78335c 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -45,11 +45,13 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
* UTF-32BE - {@link ByteOrderMark#UTF_32LE}
* UTF-32LE - {@link ByteOrderMark#UTF_32BE}
*
- *
+ *
+ * To build an instance, see {@link Builder}.
+ *
* Example 1 - Detect and exclude a UTF-8 BOM
*
*
- * BOMInputStream bomIn = new BOMInputStream(in);
+ * BOMInputStream bomIn = BOMInputStream.builder().setInputStream(in).get();
* if (bomIn.hasBOM()) {
* // has a UTF-8 BOM
* }
@@ -59,7 +61,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
*
*
* boolean include = true;
- * BOMInputStream bomIn = new BOMInputStream(in, include);
+ * BOMInputStream bomIn =
BOMInputStream.builder().setInputStream(in).setInclude(include).get();
* if (bomIn.hasBOM()) {
* // has a UTF-8 BOM
* }
@@ -68,10
[commons-io] branch master updated: Javadoc
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 4c46df1d Javadoc
4c46df1d is described below
commit 4c46df1dccc544332e212ea3d8e51e7adc23d1f5
Author: Gary Gregory
AuthorDate: Thu May 18 08:24:55 2023 -0400
Javadoc
---
src/test/java/org/apache/commons/io/input/StringInputStream.java | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/test/java/org/apache/commons/io/input/StringInputStream.java
b/src/test/java/org/apache/commons/io/input/StringInputStream.java
index 3eb7269e..d4a5e1bd 100644
--- a/src/test/java/org/apache/commons/io/input/StringInputStream.java
+++ b/src/test/java/org/apache/commons/io/input/StringInputStream.java
@@ -51,7 +51,6 @@ public class StringInputStream extends ReaderInputStream {
* Constructs a new instance.
*
* Only uses the String and Charset aspects of this builder.
- * @throws UnsupportedOperationException if the origin cannot be
converted to a Reader.
*/
@Override
public StringInputStream get() {
[commons-io] branch master updated: Javadoc
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 598ac655 Javadoc
598ac655 is described below
commit 598ac655967af8937fed81fa88d85ded13a48878
Author: Gary Gregory
AuthorDate: Thu May 18 08:24:39 2023 -0400
Javadoc
---
src/test/java/org/apache/commons/io/input/StringInputStream.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/input/StringInputStream.java
b/src/test/java/org/apache/commons/io/input/StringInputStream.java
index e54fc1b4..3eb7269e 100644
--- a/src/test/java/org/apache/commons/io/input/StringInputStream.java
+++ b/src/test/java/org/apache/commons/io/input/StringInputStream.java
@@ -31,12 +31,12 @@ import org.apache.commons.io.build.AbstractStreamBuilder;
public class StringInputStream extends ReaderInputStream {
/**
- * Builds a new {@link ReaderInputStream} instance.
+ * Builds a new {@link StringInputStream} instance.
*
* For example:
*
* {@code
- * ReaderInputStream s = ReaderInputStream.builder()
+ * ReaderInputStream s = new StringInputStream.Builder()
* .setString("String")
* .setCharsetEncoder(Charset.defaultCharset())
* .get()}
[commons-io] branch master updated: Javadoc
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 b5abc78e Javadoc
b5abc78e is described below
commit b5abc78e7ac91ce269a5be5097aaddf1d9847b2e
Author: Gary Gregory
AuthorDate: Fri May 12 15:21:49 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/FileUtils.java | 78 --
1 file changed, 43 insertions(+), 35 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index 7694959d..16d0d750 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1088,12 +1088,12 @@ public class FileUtils {
}
/**
- * Creates all parent directories for a File object, including any
necessary but nonexistent
- * parent directories. If a directory already exists, nothing happens;
null input is a noop.
+ * Creates all parent directories for a File object, including any
necessary but nonexistent parent directories. If a parent directory already
exists or is
+ * null, nothing happens.
*
* @param file the File that may need parents, may be null.
- * @return The parent directory, or {@code null} if the given file does
not name a parent
- * @throws IOException if the directory was not created along with all its
parent directories.
+ * @return The parent directory, or {@code null} if the given File does
have a parent.
+ * @throws IOException if the directory was not created along with
all its parent directories.
* @throws SecurityException See {@link File#mkdirs()}.
* @since 2.9.0
*/
@@ -1364,33 +1364,39 @@ public class FileUtils {
}
/**
- * Makes a directory, including any necessary but nonexistent parent
- * directories. If a file already exists with the specified name but it is
- * not a directory then an {@link IOException} is thrown.
- * If the directory cannot be created (or the file already exists but is
not a directory)
- * then an {@link IOException} is thrown.
+ * Calls {@link File#mkdirs()} and throws an {@link IOException} on
failure.
+ *
+ * Creates all directories for a File object, including any necessary but
nonexistent parent directories. If the {@code directory} already exists or is
+ * null, nothing happens.
+ *
*
- * @param directory directory to create, may be {@code null}.
- * @throws IOException if the directory was not created along with all its
parent directories.
- * @throws IOException if the given file object is not a directory.
+ * @param directory the receiver for {@code mkdirs()}. If the {@code
directory} already exists or is null, nothing happens.
+ * @throws IOException if the directory was not created along with
all its parent directories.
+ * @throws IOException if the given file object is not a directory.
* @throws SecurityException See {@link File#mkdirs()}.
+ * @see File#mkdirs()
*/
public static void forceMkdir(final File directory) throws IOException {
mkdirs(directory);
}
/**
- * Makes any necessary but nonexistent parent directories for a given
File. If the parent directory cannot be
- * created then an IOException is thrown.
+ * Calls {@link File#mkdirs()} and throws an {@link IOException} on
failure.
+ *
+ * Creates all directories for a File object, including any necessary but
nonexistent parent directories. If the {@code directory} already exists or is
+ * null, nothing happens.
+ *
*
- * @param file file with parent to create, must not be {@code null}.
+ * @param file file with parents to create, must not be {@code null}.
* @throws NullPointerException if the file is {@code null}.
- * @throws IOException if the parent directory cannot be created.
+ * @throws IOException if the directory was not created along
with all its parent directories.
+ * @throws IOException if the given file object is not a
directory.
+ * @throws SecurityExceptionSee {@link File#mkdirs()}.
+ * @see File#mkdirs()
* @since 2.5
*/
public static void forceMkdirParent(final File file) throws IOException {
-Objects.requireNonNull(file, "file");
-forceMkdir(getParentFile(file));
+forceMkdir(getParentFile(Objects.requireNonNull(file, "file")));
}
/**
@@ -2263,16 +2269,16 @@ public class FileUtils {
}
/**
- * Calls {@link File#mkdirs()} and throws an exception on failure.
+ * Calls {@link File#mkdirs()} and throws an {@link IOException} on
failure.
*
- * Creates all directories for a File object, including any necessary but
[commons-io] branch master updated: Javadoc
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 8d8be23c Javadoc
8d8be23c is described below
commit 8d8be23c6bd56eb22df04878fa81549007f3fbc3
Author: Gary Gregory
AuthorDate: Thu May 11 09:45:54 2023 -0400
Javadoc
Add a test
---
src/main/java/org/apache/commons/io/FileUtils.java | 41 ++
.../java/org/apache/commons/io/FileUtilsTest.java | 8 +
2 files changed, 35 insertions(+), 14 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index b0d9f9e0..7694959d 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1088,12 +1088,13 @@ public class FileUtils {
}
/**
- * Creates all parent directories for a File object.
+ * Creates all parent directories for a File object, including any
necessary but nonexistent
+ * parent directories. If a directory already exists, nothing happens;
null input is a noop.
*
* @param file the File that may need parents, may be null.
* @return The parent directory, or {@code null} if the given file does
not name a parent
* @throws IOException if the directory was not created along with all its
parent directories.
- * @throws IOException if the given file object is not null and not a
directory.
+ * @throws SecurityException See {@link File#mkdirs()}.
* @since 2.9.0
*/
public static File createParentDirectories(final File file) throws
IOException {
@@ -1279,7 +1280,8 @@ public class FileUtils {
}
/**
- * Internal copy directory method.
+ * Internal copy directory method. Creates all destination parent
directories,
+ * including any necessary but nonexistent parent directories.
*
* @param srcDir the validated source directory, must not be {@code null}.
* @param destDir the validated destination directory, must not be {@code
null}.
@@ -1288,7 +1290,7 @@ public class FileUtils {
* @param preserveDirDate preserve the directories last modified dates.
* @param copyOptions options specifying how the copy should be done, see
{@link StandardCopyOption}.
* @throws IOException if the directory was not created along with all its
parent directories.
- * @throws IOException if the given file object is not a directory.
+ * @throws SecurityException See {@link File#mkdirs()}.
*/
private static void doCopyDirectory(final File srcDir, final File destDir,
final FileFilter fileFilter, final List exclusionList,
final boolean preserveDirDate, final CopyOption... copyOptions) throws
IOException {
@@ -1363,10 +1365,10 @@ public class FileUtils {
/**
* Makes a directory, including any necessary but nonexistent parent
- * directories. If a file already exists with specified name but it is
- * not a directory then an IOException is thrown.
+ * directories. If a file already exists with the specified name but it is
+ * not a directory then an {@link IOException} is thrown.
* If the directory cannot be created (or the file already exists but is
not a directory)
- * then an IOException is thrown.
+ * then an {@link IOException} is thrown.
*
* @param directory directory to create, may be {@code null}.
* @throws IOException if the directory was not created along with all its
parent directories.
@@ -1430,10 +1432,10 @@ public class FileUtils {
}
/**
- * Gets the parent of the given file. The given file may be bull and a
file's parent may as well be null.
+ * Gets the parent of the given file. The given file may be null. Note
that a file's parent may be null as well.
*
- * @param file The file to query.
- * @return The parent file or {@code null}.
+ * @param file The file to query, may be null.
+ * @return The parent file or {@code null}. Note that a file's parent may
be null as well.
*/
private static File getParentFile(final File file) {
return file == null ? null : file.getParentFile();
@@ -2262,9 +2264,13 @@ public class FileUtils {
/**
* Calls {@link File#mkdirs()} and throws an exception on failure.
+ *
+ * Creates all directories for a File object, including any necessary but
nonexistent
+ * parent directories. If a directory already exists, nothing happens;
null input is a noop.
+ *
*
- * @param directory the receiver for {@code mkdirs()}, may be null.
- * @return the given file, may be null.
+ * @param directory the receiver for {@code mkdirs()}, passing null is a
noop.
+ * @return the given directory.
* @throws IOException if the directory was not created
[commons-io] branch master updated: Javadoc
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 6a9cb38e Javadoc
6a9cb38e is described below
commit 6a9cb38eeec6df877aba4fc6d06e83d7eb17a684
Author: Gary Gregory
AuthorDate: Sun May 7 09:57:41 2023 -0400
Javadoc
Source clean up
---
.../java/org/apache/commons/io/input/BOMInputStream.java | 14 --
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 36b4e005..252803df 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -98,6 +98,7 @@ public class BOMInputStream extends ProxyInputStream {
*
* {@code
* BOMInputStream s = BOMInputStream.builder()
+ * .setPath(path)
* .setByteOrderMarks(ByteOrderMark.UTF_8)
* .setInclude(false)
* .get()}
@@ -113,10 +114,11 @@ public class BOMInputStream extends ProxyInputStream {
static ByteOrderMark getDefaultBOM() {
return DEFAULT[0];
}
-private boolean include;
private ByteOrderMark[] byteOrderMarks = DEFAULT;
+private boolean include;
+
/**
* Constructs a new instance.
*
@@ -168,18 +170,18 @@ public class BOMInputStream extends ProxyInputStream {
return new Builder();
}
-private final boolean include;
-
/**
* BOMs are sorted from longest to shortest.
*/
private final List boms;
+
private ByteOrderMark byteOrderMark;
-private int[] firstBytes;
-private int fbLength;
private int fbIndex;
-private int markFbIndex;
+private int fbLength;
+private int[] firstBytes;
+private final boolean include;
private boolean markedAtStart;
+private int markFbIndex;
/**
* Constructs a new BOM InputStream that excludes a {@link
ByteOrderMark#UTF_8} BOM.
[commons-io] branch master updated: Javadoc
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 db436445 Javadoc
db436445 is described below
commit db4364457a21dd20d44f97faed864b32eb5344ad
Author: Gary Gregory
AuthorDate: Tue May 2 17:44:49 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/output/NullOutputStream.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/output/NullOutputStream.java
b/src/main/java/org/apache/commons/io/output/NullOutputStream.java
index 0fd2a53d..de630bf4 100644
--- a/src/main/java/org/apache/commons/io/output/NullOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/NullOutputStream.java
@@ -43,11 +43,11 @@ public class NullOutputStream extends OutputStream {
public static final NullOutputStream NULL_OUTPUT_STREAM = INSTANCE;
/**
- * Deprecated in favor of {@link #NULL_OUTPUT_STREAM}.
+ * Deprecated in favor of {@link #INSTANCE}.
*
* TODO: Will be private in 3.0.
*
- * @deprecated Use {@link #NULL_OUTPUT_STREAM}.
+ * @deprecated Use {@link #INSTANCE}.
*/
@Deprecated
public NullOutputStream() {
[commons-io] branch master updated: Javadoc
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 cfb8f3c6 Javadoc
cfb8f3c6 is described below
commit cfb8f3c6eb1db354d4dc24f8d88ca68134392b41
Author: Gary Gregory
AuthorDate: Tue May 2 17:42:31 2023 -0400
Javadoc
---
.../apache/commons/io/build/AbstractOrigin.java| 35 ++
.../commons/io/build/AbstractOriginSupplier.java | 6
.../commons/io/build/AbstractStreamBuilder.java| 6
3 files changed, 47 insertions(+)
diff --git a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
index 1e4ca524..cb793ab3 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
@@ -45,6 +45,11 @@ public abstract class AbstractOrigin> extends
*/
public static class FileOrigin extends AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public FileOrigin(final File origin) {
super(origin);
}
@@ -69,6 +74,11 @@ public abstract class AbstractOrigin> extends
*/
public static class InputStreamOrigin extends AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public InputStreamOrigin(final InputStream origin) {
super(origin);
}
@@ -88,6 +98,11 @@ public abstract class AbstractOrigin> extends
*/
public static class OutputStreamOrigin extends
AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public OutputStreamOrigin(final OutputStream origin) {
super(origin);
}
@@ -104,6 +119,11 @@ public abstract class AbstractOrigin> extends
*/
public static class PathOrigin extends AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public PathOrigin(final Path origin) {
super(origin);
}
@@ -128,6 +148,11 @@ public abstract class AbstractOrigin> extends
*/
public static class ReaderOrigin extends AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public ReaderOrigin(final Reader origin) {
super(origin);
}
@@ -143,6 +168,11 @@ public abstract class AbstractOrigin> extends
*/
public static class URIOrigin extends AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public URIOrigin(final URI origin) {
super(origin);
}
@@ -172,6 +202,11 @@ public abstract class AbstractOrigin> extends
*/
public static class WriterOrigin extends AbstractOrigin {
+/**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public WriterOrigin(final Writer origin) {
super(origin);
}
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
index 6935e9e0..9f2c599a 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
@@ -44,6 +44,12 @@ import
org.apache.commons.io.build.AbstractOrigin.WriterOrigin;
*/
public abstract class AbstractOriginSupplier> extends AbstractSupplier {
+/**
+ * Throws {@link IllegalArgumentException} if the initialBufferSize is
less than zero.
+ *
+ * @param initialBufferSize the value to test.
+ * @return the input value.
+ */
protected static int checkBufferSize(final int initialBufferSize) {
if (initialBufferSize < 0) {
throw new IllegalArgumentException("Initial buffer size must be at
least 0.");
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
index 3bc2f22d..c42aff52 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
@@ -31,6 +31,12 @@ import org.apache.commons.io.IOUtils;
*/
public abstract class AbstractStreamBuilder> extends AbstractOriginSupplier {
+/**
+ * Throws {@link
[commons-io] branch master updated: Javadoc deprecation of Serializable
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 494c5a2c Javadoc deprecation of Serializable
494c5a2c is described below
commit 494c5a2cbb8bb00e31032b7a600fc7914b21d041
Author: Gary Gregory
AuthorDate: Tue May 2 17:38:47 2023 -0400
Javadoc deprecation of Serializable
---
src/main/java/org/apache/commons/io/ByteOrderMark.java | 4
.../apache/commons/io/comparator/CompositeFileComparator.java| 4
.../org/apache/commons/io/comparator/DefaultFileComparator.java | 4
.../apache/commons/io/comparator/DirectoryFileComparator.java| 4
.../apache/commons/io/comparator/ExtensionFileComparator.java| 4
.../apache/commons/io/comparator/LastModifiedFileComparator.java | 4
.../org/apache/commons/io/comparator/NameFileComparator.java | 4
.../org/apache/commons/io/comparator/PathFileComparator.java | 5 -
.../org/apache/commons/io/comparator/ReverseFileComparator.java | 4
.../org/apache/commons/io/comparator/SizeFileComparator.java | 8
.../java/org/apache/commons/io/filefilter/AgeFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/AndFileFilter.java | 4
.../org/apache/commons/io/filefilter/CanExecuteFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/CanReadFileFilter.java | 4
.../org/apache/commons/io/filefilter/CanWriteFileFilter.java | 9 ++---
.../org/apache/commons/io/filefilter/DelegateFileFilter.java | 4
.../org/apache/commons/io/filefilter/DirectoryFileFilter.java| 4
.../java/org/apache/commons/io/filefilter/EmptyFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/FalseFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/FileFileFilter.java| 4
.../java/org/apache/commons/io/filefilter/HiddenFileFilter.java | 4
.../org/apache/commons/io/filefilter/MagicNumberFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/NameFileFilter.java| 4
.../java/org/apache/commons/io/filefilter/NotFileFilter.java | 4
src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/PrefixFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/RegexFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/SizeFileFilter.java| 4
.../java/org/apache/commons/io/filefilter/SuffixFileFilter.java | 4
.../org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/TrueFileFilter.java| 4
.../org/apache/commons/io/filefilter/WildcardFileFilter.java | 4
.../java/org/apache/commons/io/filefilter/WildcardFilter.java| 4
.../java/org/apache/commons/io/input/CharSequenceReader.java | 4
src/main/java/org/apache/commons/io/input/TaggedInputStream.java | 4
src/main/java/org/apache/commons/io/input/TaggedReader.java | 4
.../org/apache/commons/io/monitor/FileAlterationObserver.java| 4
src/main/java/org/apache/commons/io/monitor/FileEntry.java | 4
.../java/org/apache/commons/io/output/StringBuilderWriter.java | 5 -
.../org/apache/commons/io/filefilter/RegexFileFilterTest.java| 1 +
40 files changed, 163 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java
b/src/main/java/org/apache/commons/io/ByteOrderMark.java
index af235c3e..8762f9a0 100644
--- a/src/main/java/org/apache/commons/io/ByteOrderMark.java
+++ b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -23,6 +23,10 @@ import java.util.Objects;
/**
* Byte Order Mark (BOM) representation - see {@link
org.apache.commons.io.input.BOMInputStream}.
+ * Deprecating Serialization
+ *
+ * Serialization is deprecated and will be removed in 3.0.
+ *
*
* @see org.apache.commons.io.input.BOMInputStream
* @see http://en.wikipedia.org/wiki/Byte_order_mark;>Wikipedia: Byte
Order Mark
diff --git
a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
index f29b2746..0f57a833 100644
---
a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
+++
b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
@@ -36,6 +36,10 @@ import java.util.stream.StreamSupport;
* ListFile list = ...
* comparator.sort(list);
*
+ * Deprecating Serialization
+ *
+ * Serialization is deprecated and will be removed in 3.0.
+ *
*
* @since 2.0
*/
diff --git
a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
[commons-io] branch master updated: Javadoc
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 6d5d3afb Javadoc
6d5d3afb is described below
commit 6d5d3afb89dc70db67c2ecc8b5c1a9d8788187e5
Author: Gary Gregory
AuthorDate: Fri Apr 28 17:05:42 2023 -0400
Javadoc
---
.../commons/io/output/DeferredFileOutputStreamTest.java| 14 +++---
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git
a/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
b/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
index a2b14437..35038d2e 100644
---
a/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
+++
b/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
@@ -182,7 +182,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test specifying a temporary file and the threshold is reached.
+ * Tests specifying a temporary file and the threshold is reached.
*/
@ParameterizedTest(name = "initialBufferSize = {0}")
@MethodSource("data")
@@ -218,7 +218,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test specifying a temporary file and the threshold is reached.
+ * Tests specifying a temporary file and the threshold is reached.
* @throws IOException
*/
@ParameterizedTest(name = "initialBufferSize = {0}")
@@ -254,7 +254,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test specifying a temporary file and the threshold not reached.
+ * Tests specifying a temporary file and the threshold not reached.
* @throws IOException
*/
@ParameterizedTest(name = "initialBufferSize = {0}")
@@ -273,7 +273,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test specifying a temporary file and the threshold is reached.
+ * Tests specifying a temporary file and the threshold is reached.
*
* @throws Exception
*/
@@ -320,7 +320,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test whether writeTo() properly writes large content.
+ * Tests whether writeTo() properly writes large content.
*/
@ParameterizedTest(name = "initialBufferSize = {0}")
@MethodSource("data")
@@ -347,7 +347,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test whether writeTo() properly writes large content.
+ * Tests whether writeTo() properly writes large content.
*/
@ParameterizedTest(name = "initialBufferSize = {0}")
@MethodSource("data")
@@ -374,7 +374,7 @@ public class DeferredFileOutputStreamTest {
}
/**
- * Test whether writeTo() properly writes small content.
+ * Tests whether writeTo() properly writes small content.
* @throws IOException
*/
@ParameterizedTest(name = "initialBufferSize = {0}")
[commons-io] branch master updated: Javadoc
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 0a74dfae Javadoc
0a74dfae is described below
commit 0a74dfaeb62e2c18dba7a02c53b56b89c6646acd
Author: Gary Gregory
AuthorDate: Fri Apr 28 15:00:00 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/comparator/package-info.java | 2 +-
src/main/java/org/apache/commons/io/file/attribute/package-info.java | 2 +-
src/main/java/org/apache/commons/io/file/package-info.java | 2 +-
src/main/java/org/apache/commons/io/file/spi/package-info.java | 2 +-
src/main/java/org/apache/commons/io/filefilter/package-info.java | 2 +-
src/main/java/org/apache/commons/io/function/package-info.java | 2 +-
src/main/java/org/apache/commons/io/input/buffer/package-info.java | 2 +-
src/main/java/org/apache/commons/io/input/package-info.java | 2 +-
src/main/java/org/apache/commons/io/monitor/package-info.java| 2 +-
src/main/java/org/apache/commons/io/output/package-info.java | 2 +-
src/main/java/org/apache/commons/io/package-info.java| 2 +-
src/main/java/org/apache/commons/io/serialization/package-info.java | 2 +-
12 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/comparator/package-info.java
b/src/main/java/org/apache/commons/io/comparator/package-info.java
index b1272c1e..3a0926db 100644
--- a/src/main/java/org/apache/commons/io/comparator/package-info.java
+++ b/src/main/java/org/apache/commons/io/comparator/package-info.java
@@ -16,7 +16,7 @@
*/
/**
- * This package provides various {@link java.util.Comparator} implementations
+ * Provides various {@link java.util.Comparator} implementations
* for {@link java.io.File}s.
* Sorting
*
diff --git
a/src/main/java/org/apache/commons/io/file/attribute/package-info.java
b/src/main/java/org/apache/commons/io/file/attribute/package-info.java
index 351bb631..a8485cb6 100644
--- a/src/main/java/org/apache/commons/io/file/attribute/package-info.java
+++ b/src/main/java/org/apache/commons/io/file/attribute/package-info.java
@@ -16,6 +16,6 @@
*/
/**
- * Helps use {@link java.nio.file.attribute}.
+ * Provides help using {@link java.nio.file.attribute} types.
*/
package org.apache.commons.io.file.attribute;
diff --git a/src/main/java/org/apache/commons/io/file/package-info.java
b/src/main/java/org/apache/commons/io/file/package-info.java
index 8396fa4e..c1be3a51 100644
--- a/src/main/java/org/apache/commons/io/file/package-info.java
+++ b/src/main/java/org/apache/commons/io/file/package-info.java
@@ -16,6 +16,6 @@
*/
/**
- * This package provides extensions in the realm of {@link java.nio.file}.
+ * Provides extensions in the realm of {@link java.nio.file}.
*/
package org.apache.commons.io.file;
diff --git a/src/main/java/org/apache/commons/io/file/spi/package-info.java
b/src/main/java/org/apache/commons/io/file/spi/package-info.java
index d347ee52..5630dc02 100644
--- a/src/main/java/org/apache/commons/io/file/spi/package-info.java
+++ b/src/main/java/org/apache/commons/io/file/spi/package-info.java
@@ -16,7 +16,7 @@
*/
/**
- * This package provides extensions in the realm of {@link java.nio.file.spi}.
+ * Provides extensions in the realm of {@link java.nio.file.spi}.
*
* @since 2.9.0
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/package-info.java
b/src/main/java/org/apache/commons/io/filefilter/package-info.java
index 73f980fe..a374fb0d 100644
--- a/src/main/java/org/apache/commons/io/filefilter/package-info.java
+++ b/src/main/java/org/apache/commons/io/filefilter/package-info.java
@@ -16,7 +16,7 @@
*/
/**
- * This package defines an interface (IOFileFilter) that combines both
+ * Provides the an interface {@link
org.apache.commons.io.filefilter.IOFileFilter IOFileFilter} that combines both
* {@link java.io.FileFilter} and {@link java.io.FilenameFilter}.
* Besides that the package offers a series of ready-to-use implementations
of the
* IOFileFilter interface including implementation that allow you to combine
diff --git a/src/main/java/org/apache/commons/io/function/package-info.java
b/src/main/java/org/apache/commons/io/function/package-info.java
index 2ae667a2..7244ada4 100644
--- a/src/main/java/org/apache/commons/io/function/package-info.java
+++ b/src/main/java/org/apache/commons/io/function/package-info.java
@@ -16,6 +16,6 @@
*/
/**
- * This package defines IO-only related functional interfaces for lambda
expressions and method references.
+ * Provides IO-only related functional interfaces for lambda expressions and
method references.
*/
package org.apache.commons.io.function;
diff --git a/src/main/java/org/apache/commons/io/input/buffer/package-info.java
[commons-io] branch master updated: Javadoc
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 37242322 Javadoc
37242322 is described below
commit 372423224532edfef0afd87046e811cad8504735
Author: Gary Gregory
AuthorDate: Tue Apr 25 16:50:21 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/XmlStreamReader.java | 10 ++
1 file changed, 10 insertions(+)
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
index 8dd121bb..e5924eac 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -330,6 +330,7 @@ public class XmlStreamReader extends Reader {
*
*
* @param file File to create a Reader from.
+ * @throws NullPointerException if the input is {@code null}.
* @throws IOException thrown if there is a problem reading the file.
* @deprecated Use {@link #builder()}
*/
@@ -348,6 +349,7 @@ public class XmlStreamReader extends Reader {
*
*
* @param inputStream InputStream to create a Reader from.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading the stream.
* @deprecated Use {@link #builder()}
*/
@@ -382,6 +384,7 @@ public class XmlStreamReader extends Reader {
*
* @param inputStream InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection should
be relaxed.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the stream.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specs.
* @deprecated Use {@link #builder()}
@@ -418,6 +421,7 @@ public class XmlStreamReader extends Reader {
* @param inputStream InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection
should be relaxed.
* @param defaultEncoding The default encoding
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the stream.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specs.
* @deprecated Use {@link #builder()}
@@ -445,6 +449,7 @@ public class XmlStreamReader extends Reader {
*
* @param inputStream InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of
the charset encoding.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading the file.
* @deprecated Use {@link #builder()}
*/
@@ -481,6 +486,7 @@ public class XmlStreamReader extends Reader {
* @param inputStream InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of
the charset encoding.
* @param lenient indicates if the charset encoding detection
should be relaxed.
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the file.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specification.
* @deprecated Use {@link #builder()}
@@ -519,6 +525,7 @@ public class XmlStreamReader extends Reader {
* @param httpContentType content-type header to use for the resolution of
the charset encoding.
* @param lenient indicates if the charset encoding detection
should be relaxed.
* @param defaultEncoding The default encoding
+ * @throws NullPointerException if the input stream is {@code null}.
* @throws IOException thrown if there is a problem reading
the file.
* @throws XmlStreamReaderException thrown if the charset encoding could
not be determined according to the specification.
* @deprecated Use {@link #builder()}
@@ -545,6 +552,7 @@ public class XmlStreamReader extends Reader {
*
*
* @param file File to create a Reader from.
+ * @throws NullPointerException if the input is {@code null}.
* @throws IOException thrown if there is a problem reading the file.
* @since 2.11.0
* @deprecated Use {@link #builder()}
@@ -568,6 +576,7 @@ public class XmlStreamReader extends Reader {
*
*
* @param url URL to create a Reader from.
+ * @throws NullPointerException if the input is
[commons-io] branch master updated: Javadoc
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 1010f48b Javadoc
1010f48b is described below
commit 1010f48b0cdbc4f824aefcd654de74d520a1f44c
Author: Gary Gregory
AuthorDate: Mon Apr 3 12:46:07 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/input/BoundedInputStream.java | 10 +-
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
index 14348c32..51bfb2eb 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -37,19 +37,19 @@ import java.io.InputStream;
*/
public class BoundedInputStream extends InputStream {
-/** The wrapped input stream */
+/** The wrapped input stream. */
private final InputStream inputStream;
-/** The max length to provide */
+/** The max length to read. */
private final long maxLength;
-/** The number of bytes already returned */
+/** The number of bytes already returned. */
private long pos;
-/** The marked position */
+/** The marked position. */
private long mark = EOF;
-/** Flag if close should be propagated */
+/** Flag if close should be propagated. */
private boolean propagateClose = true;
/**
[commons-io] branch master updated: Javadoc/Comments: Remove extra "whitespace"
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 c649d3db Javadoc/Comments: Remove extra "whitespace"
c649d3db is described below
commit c649d3dbfa5e2c819cef01bbacef5dacb902c6fb
Author: Gary Gregory
AuthorDate: Sat Mar 25 09:27:54 2023 -0400
Javadoc/Comments: Remove extra "whitespace"
---
src/main/java/org/apache/commons/io/FileCleaningTracker.java | 1 -
src/main/java/org/apache/commons/io/ThreadMonitor.java | 1 -
src/main/java/org/apache/commons/io/input/NullInputStream.java | 1 -
src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java| 1 -
.../java/org/apache/commons/io/input/UncheckedFilterInputStream.java | 1 -
src/main/java/org/apache/commons/io/output/CountingOutputStream.java | 1 -
src/main/java/org/apache/commons/io/output/DemuxOutputStream.java| 1 -
src/main/java/org/apache/commons/io/output/ProxyOutputStream.java| 1 -
src/test/java/org/apache/commons/io/DirectoryWalkerTest.java | 1 -
src/test/java/org/apache/commons/io/EndianUtilsTest.java | 1 -
src/test/java/org/apache/commons/io/FileSystemUtilsTest.java | 1 -
.../java/org/apache/commons/io/FileUtilsDeleteDirectoryBaseTest.java | 1 -
src/test/java/org/apache/commons/io/HexDumpTest.java | 1 -
src/test/java/org/apache/commons/io/SelectorAdapter.java | 1 -
src/test/java/org/apache/commons/io/input/BOMInputStreamTest.java| 1 -
src/test/java/org/apache/commons/io/input/BoundedInputStreamTest.java| 1 -
src/test/java/org/apache/commons/io/input/CharSequenceReaderTest.java| 1 -
src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java | 1 -
src/test/java/org/apache/commons/io/input/NullInputStreamTest.java | 1 -
src/test/java/org/apache/commons/io/input/NullReaderTest.java| 1 -
src/test/java/org/apache/commons/io/input/StringInputStream.java | 1 -
src/test/java/org/apache/commons/io/input/StringInputStreamTest.java | 1 -
.../java/org/apache/commons/io/input/SwappedDataInputStreamTest.java | 1 -
.../apache/commons/io/input/compatibility/XmlStreamReaderException.java | 1 -
.../java/org/apache/commons/io/output/AppendableOutputStreamTest.java| 1 -
src/test/java/org/apache/commons/io/output/AppendableWriterTest.java | 1 -
src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java | 1 -
.../java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java | 1 -
.../java/org/apache/commons/io/output/FileWriterWithEncodingTest.java| 1 -
src/test/java/org/apache/commons/io/output/LockableFileWriterTest.java | 1 -
src/test/java/org/apache/commons/io/output/ProxyWriterTest.java | 1 -
src/test/java/org/apache/commons/io/output/StringBuilderWriterTest.java | 1 -
32 files changed, 32 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileCleaningTracker.java
b/src/main/java/org/apache/commons/io/FileCleaningTracker.java
index e4787c7c..0980bed0 100644
--- a/src/main/java/org/apache/commons/io/FileCleaningTracker.java
+++ b/src/main/java/org/apache/commons/io/FileCleaningTracker.java
@@ -39,7 +39,6 @@ import java.util.Objects;
* longer needed. This is done by invoking the method
* {@link #exitWhenFinished}, typically in
* {@code
javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}
or similar.
- *
*/
public class FileCleaningTracker {
diff --git a/src/main/java/org/apache/commons/io/ThreadMonitor.java
b/src/main/java/org/apache/commons/io/ThreadMonitor.java
index a97036bc..9929f696 100644
--- a/src/main/java/org/apache/commons/io/ThreadMonitor.java
+++ b/src/main/java/org/apache/commons/io/ThreadMonitor.java
@@ -36,7 +36,6 @@ import java.time.Duration;
* // timed amount was reached
* }
*
- *
*/
class ThreadMonitor implements Runnable {
diff --git a/src/main/java/org/apache/commons/io/input/NullInputStream.java
b/src/main/java/org/apache/commons/io/input/NullInputStream.java
index 9c5745fe..4b550a71 100644
--- a/src/main/java/org/apache/commons/io/input/NullInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/NullInputStream.java
@@ -63,7 +63,6 @@ import java.io.InputStream;
*
*
* @since 1.3
- *
*/
public class NullInputStream extends InputStream {
diff --git
a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
index 3df793aa..31600f58 100644
--- a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
@@ -31,7 +31,6 @@ import org.apache.commons.io.EndianUtils;
*
* Origin
[commons-io] branch master updated: Javadoc tweaks
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 55841cd2 Javadoc tweaks
55841cd2 is described below
commit 55841cd2071917be628778de6f03dae9e3a349f0
Author: Gary Gregory
AuthorDate: Sat Sep 17 20:02:42 2022 -0400
Javadoc tweaks
---
src/main/java/org/apache/commons/io/function/IOConsumer.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/function/IOConsumer.java
b/src/main/java/org/apache/commons/io/function/IOConsumer.java
index d65b2a18..e417178f 100644
--- a/src/main/java/org/apache/commons/io/function/IOConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOConsumer.java
@@ -42,9 +42,9 @@ public interface IOConsumer {
/**
* Performs an action for each element of the collection gathering any
exceptions.
+ *
* @param action The action to apply to each input element.
* @param iterable The input to stream.
- *
* @param The element type.
* @throws IOExceptionList if any I/O errors occur.
* @since 2.12.0
@@ -55,9 +55,9 @@ public interface IOConsumer {
/**
* Performs an action for each element of the collection gathering any
exceptions.
+ *
* @param action The action to apply to each input element.
* @param stream The input to stream.
- *
* @param The element type.
* @throws IOExceptionList if any I/O errors occur.
* @since 2.12.0
@@ -68,9 +68,9 @@ public interface IOConsumer {
/**
* Performs an action for each element of the array gathering any
exceptions.
+ *
* @param action The action to apply to each input element.
* @param array The input to stream.
- *
* @param The element type.
* @throws IOExceptionList if any I/O errors occur.
* @since 2.12.0
[commons-io] branch master updated: Javadoc
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 88e26147 Javadoc
88e26147 is described below
commit 88e2614726c85d9082bc43d5fa45dbbd5b50b128
Author: Gary Gregory
AuthorDate: Sat Sep 17 17:13:15 2022 -0400
Javadoc
---
src/test/java/org/apache/commons/io/IOUtilsCopyTest.java | 11 +++
1 file changed, 3 insertions(+), 8 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
b/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
index 6ce0e7df..75e00bd2 100644
--- a/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
+++ b/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
@@ -45,9 +45,7 @@ import
org.apache.commons.io.test.ThrowOnFlushAndCloseOutputStream;
import org.junit.jupiter.api.Test;
/**
- * JUnit tests for IOUtils copy methods.
- *
- * @see IOUtils
+ * Test {@link IOUtils} copy methods.
*/
public class IOUtilsCopyTest {
@@ -60,7 +58,6 @@ public class IOUtilsCopyTest {
private static final int FILE_SIZE = 1024 * 4 + 1;
-
private final byte[] inData = TestUtils.generateTestData(FILE_SIZE);
@SuppressWarnings("resource") // 'in' is deliberately not closed
@@ -288,7 +285,6 @@ public class IOUtilsCopyTest {
// Test copyLarge() method
assertEquals(size, IOUtils.copyLarge(reader, writer), "copy()");
-
}
@Test
@@ -419,8 +415,8 @@ public class IOUtilsCopyTest {
assertArrayEquals(inData, baout.toByteArray(), "Content differs");
}
-/*
- * Test Copying file > 2GB - see issue# IO-84
+/**
+ * Tests Copying file > 2GB - see issue# IO-84
*/
@Test
public void testCopy_readerToWriter_IO84() throws Exception {
@@ -436,7 +432,6 @@ public class IOUtilsCopyTest {
// Test copyLarge() method
assertEquals(size, IOUtils.copyLarge(reader, writer), "copyLarge()");
-
}
@Test
[commons-io] branch master updated: Javadoc @link tags do not need to use a FQCN for classes in java.lang
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 a92fa380 Javadoc @link tags do not need to use a FQCN for classes in
java.lang
a92fa380 is described below
commit a92fa3802f0d2c474b13c5fa1cab4777e1dd8318
Author: Gary Gregory
AuthorDate: Mon Aug 29 07:36:22 2022 -0400
Javadoc @link tags do not need to use a FQCN for classes in java.lang
---
src/main/java/org/apache/commons/io/FilenameUtils.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java
b/src/main/java/org/apache/commons/io/FilenameUtils.java
index 19187e6e..c4bb6595 100644
--- a/src/main/java/org/apache/commons/io/FilenameUtils.java
+++ b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -37,7 +37,7 @@ import java.util.stream.Stream;
*
* NOTE: You may be able to avoid using this class entirely simply by
* using JDK {@link java.io.File File} objects and the two argument constructor
- * {@link java.io.File#File(java.io.File, java.lang.String) File(File,String)}.
+ * {@link java.io.File#File(java.io.File, String) File(File,String)}.
*
*
* Most methods on this class are designed to work the same on both Unix and
Windows.
[commons-io] branch master updated: Javadoc @see tags do not need to use a FQCN for classes in java.lang
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 81aa2b9e Javadoc @see tags do not need to use a FQCN for classes in
java.lang
81aa2b9e is described below
commit 81aa2b9ec8b97bdfd035e3fc0e19b02c4c6d9fd4
Author: Gary Gregory
AuthorDate: Mon Aug 29 07:14:22 2022 -0400
Javadoc @see tags do not need to use a FQCN for classes in java.lang
---
src/main/java/org/apache/commons/io/ByteOrderMark.java | 2 +-
src/main/java/org/apache/commons/io/IOUtils.java | 18 +-
.../commons/io/input/ClassLoaderObjectInputStream.java | 2 +-
.../commons/io/output/AppendableOutputStream.java | 2 +-
.../org/apache/commons/io/output/AppendableWriter.java | 2 +-
5 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java
b/src/main/java/org/apache/commons/io/ByteOrderMark.java
index 3d5494ea..af235c3e 100644
--- a/src/main/java/org/apache/commons/io/ByteOrderMark.java
+++ b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -149,7 +149,7 @@ public class ByteOrderMark implements Serializable {
* Computes the hashcode for this BOM.
*
* @return the hashcode for this BOM.
- * @see java.lang.Object#hashCode()
+ * @see Object#hashCode()
*/
@Override
public int hashCode() {
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index e83cab9f..4b100dff 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -479,7 +479,7 @@ public class IOUtils {
* @param closeable the objects to close, may be null or already closed
* @since 2.0
*
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final Closeable closeable) {
closeQuietly(closeable, null);
@@ -529,7 +529,7 @@ public class IOUtils {
* @param closeables the objects to close, may be null or already closed
* @see #closeQuietly(Closeable)
* @since 2.5
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final Closeable... closeables) {
if (closeables != null) {
@@ -583,7 +583,7 @@ public class IOUtils {
*
*
* @param input the InputStream to close, may be null or already closed
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final InputStream input) {
closeQ(input);
@@ -633,7 +633,7 @@ public class IOUtils {
*
*
* @param output the OutputStream to close, may be null or already closed
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final OutputStream output) {
closeQ(output);
@@ -666,7 +666,7 @@ public class IOUtils {
*
*
* @param reader the Reader to close, may be null or already closed
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final Reader reader) {
closeQ(reader);
@@ -699,7 +699,7 @@ public class IOUtils {
*
* @param selector the Selector to close, may be null or already closed
* @since 2.2
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final Selector selector) {
closeQ(selector);
@@ -732,7 +732,7 @@ public class IOUtils {
*
* @param serverSocket the ServerSocket to close, may be null or already
closed
* @since 2.2
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final ServerSocket serverSocket) {
closeQ(serverSocket);
@@ -765,7 +765,7 @@ public class IOUtils {
*
* @param socket the Socket to close, may be null or already closed
* @since 2.0
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final Socket socket) {
closeQ(socket);
@@ -813,7 +813,7 @@ public class IOUtils {
*
*
* @param writer the Writer to close, may be null or already closed
- * @see Throwable#addSuppressed(java.lang.Throwable)
+ * @see Throwable#addSuppressed(Throwable)
*/
public static void closeQuietly(final Writer writer) {
closeQ(writer);
diff --git
[commons-io] branch master updated: Javadoc
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 aa219e03 Javadoc
aa219e03 is described below
commit aa219e0386da5136a31ac6e3afafe530c9266b6a
Author: Gary Gregory
AuthorDate: Sun Aug 7 07:15:45 2022 -0400
Javadoc
---
.../org/apache/commons/io/file/FilesUncheck.java | 196 ++---
1 file changed, 98 insertions(+), 98 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/file/FilesUncheck.java
b/src/main/java/org/apache/commons/io/file/FilesUncheck.java
index 44545dab..5de2a4b0 100644
--- a/src/main/java/org/apache/commons/io/file/FilesUncheck.java
+++ b/src/main/java/org/apache/commons/io/file/FilesUncheck.java
@@ -60,10 +60,10 @@ public class FilesUncheck {
* Delegates to {@link Files#copy(InputStream, Path,CopyOption...)}
throwing {@link UncheckedIOException} instead of
* {@link IOException}.
*
- * @param in See delegate. See delegate.
- * @param target See delegate. See delegate.
- * @param options See delegate. See delegate.
- * @return See delegate. See delegate.
+ * @param in See delegate.
+ * @param target See delegate.
+ * @param options See delegate.
+ * @return See delegate.
* @throws UncheckedIOException Wraps an {@link IOException}.
* @see Files#copy(InputStream, Path,CopyOption...)
*/
@@ -75,9 +75,9 @@ public class FilesUncheck {
* Delegates to {@link Files#copy(Path, OutputStream)} throwing {@link
UncheckedIOException} instead of
* {@link IOException}.
*
- * @param source See delegate. See delegate. See delegate.
- * @param out See delegate. See delegate. See delegate.
- * @return See delegate. See delegate. See delegate.
+ * @param source See delegate. See delegate.
+ * @param out See delegate. See delegate.
+ * @return See delegate. See delegate.
* @throws UncheckedIOException Wraps an {@link IOException}.
*/
public static long copy(final Path source, final OutputStream out) {
@@ -88,10 +88,10 @@ public class FilesUncheck {
* Delegates to {@link Files#copy(Path, Path, CopyOption...)} throwing
{@link UncheckedIOException} instead of
* {@link IOException}.
*
- * @param source See delegate. See delegate.
- * @param target See delegate. See delegate.
- * @param options See delegate. See delegate.
- * @return See delegate. See delegate.
+ * @param source See delegate.
+ * @param target See delegate.
+ * @param options See delegate.
+ * @return See delegate.
* @throws UncheckedIOException Wraps an {@link IOException}.
*/
public static Path copy(final Path source, final Path target, final
CopyOption... options) {
@@ -102,9 +102,9 @@ public class FilesUncheck {
* Delegates to {@link Files#createDirectories(Path, FileAttribute...)}
throwing {@link UncheckedIOException} instead of
* {@link IOException}.
*
- * @param dir See delegate. See delegate.
- * @param attrs See delegate. See delegate.
- * @return See delegate. See delegate.
+ * @param dir See delegate.
+ * @param attrs See delegate.
+ * @return See delegate.
* @throws UncheckedIOException Wraps an {@link IOException}.
*/
public static Path createDirectories(final Path dir, final
FileAttribute... attrs) {
@@ -115,9 +115,9 @@ public class FilesUncheck {
* Delegates to {@link Files#createDirectory(Path, FileAttribute...)}
throwing {@link UncheckedIOException} instead of
* {@link IOException}.
*
- * @param dir See delegate. See delegate.
- * @param attrs See delegate. See delegate.
- * @return See delegate. See delegate.
+ * @param dir See delegate.
+ * @param attrs See delegate.
+ * @return See delegate.
* @throws UncheckedIOException Wraps an {@link IOException}.
*/
public static Path createDirectory(final Path dir, final
FileAttribute... attrs) {
@@ -128,9 +128,9 @@ public class FilesUncheck {
* Delegates to {@link Files#createFile(Path, FileAttribute...)} throwing
{@link UncheckedIOException} instead of
* {@link IOException}.
*
- * @param path See delegate. See delegate.
- * @param attrs See delegate. See delegate.
- * @return See delegate. See delegate.
+ * @param path See delegate.
+ * @param attrs See delegate.
+ * @return See delegate.
* @throws UncheckedIOException Wraps an {@link IOException}.
*/
public static Path createFile(final Path path, final FileAttribute...
attrs) {
@@ -141,9 +141,9 @@ public class FilesUncheck {
* Delegates to {@link Files#createLink(Path, Path)} throwing {@link
UncheckedIOException} instead of
* {@link IOException}.
*
- * @param link See delegate. See delegate.
- * @param
[commons-io] branch master updated: Javadoc
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 15995ca7 Javadoc
15995ca7 is described below
commit 15995ca7865e38251d0ffe04c06c56c519ff541a
Author: Gary Gregory
AuthorDate: Thu Jul 28 09:30:49 2022 -0400
Javadoc
---
src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
b/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
index ffd42363..50af4a2f 100644
--- a/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
+++ b/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
@@ -28,7 +28,7 @@ import org.junit.jupiter.api.Test;
*
* This class has been broken out from FileUtilsTestCase to solve issues as
per BZ 38927
*
- *
+ *
* @see FileUtils
*/
public class FileUtilsWaitForTest {
[commons-io] branch master updated: Javadoc
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 c24bde0d Javadoc
c24bde0d is described below
commit c24bde0d76d3e9e87ae177c0589390503e17ff83
Author: Gary Gregory
AuthorDate: Thu Jul 28 09:30:13 2022 -0400
Javadoc
---
src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java | 7 ---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
b/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
index c4979b7f..ffd42363 100644
--- a/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
+++ b/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java
@@ -25,12 +25,13 @@ import org.junit.jupiter.api.Test;
/**
* This is used to test FileUtils.waitFor() method for correctness.
- *
+ *
+ * This class has been broken out from FileUtilsTestCase to solve issues as
per BZ 38927
+ *
+ *
* @see FileUtils
*/
public class FileUtilsWaitForTest {
-// This class has been broken out from FileUtilsTestCase
-// to solve issues as per BZ 38927
@Test
public void testWaitFor0() {
[commons-io] branch master updated: Javadoc
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 4b0b0179 Javadoc
4b0b0179 is described below
commit 4b0b0179da996fd2e81417fff2bfa313e12f484b
Author: Gary Gregory
AuthorDate: Tue Jul 26 19:27:33 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/function/IOPredicate.java | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/function/IOPredicate.java
b/src/main/java/org/apache/commons/io/function/IOPredicate.java
index 6cedbd4c..c7b4fe6a 100644
--- a/src/main/java/org/apache/commons/io/function/IOPredicate.java
+++ b/src/main/java/org/apache/commons/io/function/IOPredicate.java
@@ -85,7 +85,8 @@ public interface IOPredicate {
}
/**
- * Converts this predicate to a Predicate that throws {@link
UncheckedIOException} instead of {@link IOException}.
+ * Converts this instance to a {@link Predicate} that throws {@link
UncheckedIOException} instead of
+ * {@link IOException}.
*
* @return an unchecked Predicate.
*/
[commons-io] branch master updated: Javadoc
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 7db39c03 Javadoc
7db39c03 is described below
commit 7db39c030d54d8de18f267f7ae121bb77502690c
Author: Gary Gregory
AuthorDate: Mon Jul 25 10:08:50 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/file/Counters.java | 8
src/main/java/org/apache/commons/io/function/IOBiConsumer.java | 2 +-
src/main/java/org/apache/commons/io/function/IOBiFunction.java | 2 +-
src/main/java/org/apache/commons/io/function/IOConsumer.java| 4 ++--
src/main/java/org/apache/commons/io/function/IOTriConsumer.java | 2 +-
5 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/file/Counters.java
b/src/main/java/org/apache/commons/io/file/Counters.java
index 4e1811e4..2b6736c1 100644
--- a/src/main/java/org/apache/commons/io/file/Counters.java
+++ b/src/main/java/org/apache/commons/io/file/Counters.java
@@ -433,9 +433,9 @@ public class Counters {
}
/**
- * Returns the NOOP Counter.
+ * Returns the no-op Counter.
*
- * @return the NOOP Counter.
+ * @return the no-op Counter.
* @since 2.9.0
*/
public static Counter noopCounter() {
@@ -443,9 +443,9 @@ public class Counters {
}
/**
- * Returns the NOOP PathCounters.
+ * Returns the no-op PathCounters.
*
- * @return the NOOP PathCounters.
+ * @return the no-op PathCounters.
* @since 2.9.0
*/
public static PathCounters noopPathCounters() {
diff --git a/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
b/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
index 0afee728..f7dc67b8 100644
--- a/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
@@ -38,7 +38,7 @@ public interface IOBiConsumer {
*
* @param the type of the first argument to the operation
* @param the type of the second argument to the operation
- * @return The NOOP singleton.
+ * @return The no-op singleton.
*/
static IOBiConsumer noop() {
return Constants.IO_BI_CONSUMER;
diff --git a/src/main/java/org/apache/commons/io/function/IOBiFunction.java
b/src/main/java/org/apache/commons/io/function/IOBiFunction.java
index e055f740..aed614b2 100644
--- a/src/main/java/org/apache/commons/io/function/IOBiFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOBiFunction.java
@@ -45,7 +45,7 @@ public interface IOBiFunction {
* @param the type of the first argument to the function
* @param the type of the second argument to the function
* @param the type of the result of the function
- * @return The NOOP singleton.
+ * @return The no-op singleton.
*/
static IOBiFunction noop() {
return Constants.IO_BI_FUNCTION;
diff --git a/src/main/java/org/apache/commons/io/function/IOConsumer.java
b/src/main/java/org/apache/commons/io/function/IOConsumer.java
index 66f9c062..724ab1c1 100644
--- a/src/main/java/org/apache/commons/io/function/IOConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOConsumer.java
@@ -118,10 +118,10 @@ public interface IOConsumer {
}
/**
- * Returns a constant NOOP consumer.
+ * Returns a constant no-op consumer.
*
* @param Type consumer type.
- * @return a constant NOOP consumer.
+ * @return a constant no-op consumer.
* @since 2.9.0
*/
@SuppressWarnings("unchecked")
diff --git a/src/main/java/org/apache/commons/io/function/IOTriConsumer.java
b/src/main/java/org/apache/commons/io/function/IOTriConsumer.java
index a2d6b502..1d2db208 100644
--- a/src/main/java/org/apache/commons/io/function/IOTriConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOTriConsumer.java
@@ -40,7 +40,7 @@ public interface IOTriConsumer {
* @param the type of the first argument to the operation
* @param the type of the second argument to the operation
* @param the type of the third argument to the operation
- * @return The NOOP singleton.
+ * @return The no-op singleton.
*/
static IOTriConsumer noop() {
return Constants.IO_TRI_CONSUMER;
[commons-io] branch master updated: Javadoc
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 235a2433 Javadoc
235a2433 is described below
commit 235a2433eaa45f2a44019b8e8fe04106722be4b1
Author: Gary Gregory
AuthorDate: Tue Jun 28 09:24:42 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/function/IOStreams.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/function/IOStreams.java
b/src/main/java/org/apache/commons/io/function/IOStreams.java
index 74581c0f..bbcf78c8 100644
--- a/src/main/java/org/apache/commons/io/function/IOStreams.java
+++ b/src/main/java/org/apache/commons/io/function/IOStreams.java
@@ -28,7 +28,7 @@ import java.util.stream.Stream;
import org.apache.commons.io.IOExceptionList;
/**
- * Keeps code package private for now.
+ * Keep this code package-private for now.
*/
class IOStreams {
[commons-io] branch master updated: Javadoc
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 12aff370 Javadoc
12aff370 is described below
commit 12aff370caa2bb63cb948e53a46119466085b536
Author: Gary Gregory
AuthorDate: Thu Jun 23 08:42:09 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/output/ProxyWriter.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/output/ProxyWriter.java
b/src/main/java/org/apache/commons/io/output/ProxyWriter.java
index 8dd1549d..b67b22a8 100644
--- a/src/main/java/org/apache/commons/io/output/ProxyWriter.java
+++ b/src/main/java/org/apache/commons/io/output/ProxyWriter.java
@@ -162,7 +162,7 @@ public class ProxyWriter extends FilterWriter {
}
/**
- * Handle any IOExceptions thrown.
+ * Handles any IOExceptions thrown.
*
* This method provides a point to implement custom exception
* handling. The default behavior is to re-throw the exception.
[commons-io] branch master updated: Javadoc
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 94f0f788 Javadoc
94f0f788 is described below
commit 94f0f7880b9ea9b3e5221db4f34b139bf544b907
Author: Gary Gregory
AuthorDate: Tue Jun 21 13:49:16 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/IOUtils.java | 2 ++
1 file changed, 2 insertions(+)
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index 7ac55595..b923b44b 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -475,6 +475,8 @@ public class IOUtils {
/**
* Avoids the need to type cast.
+ *
+ * @param closeable the object to close, may be null
*/
private static void closeQ(final Closeable closeable) {
closeQuietly(closeable, null);
[commons-io] branch master updated: Javadoc
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 42574b3b Javadoc
42574b3b is described below
commit 42574b3b442e42d898ea8304f42e66b24e0559f8
Author: Gary Gregory
AuthorDate: Tue Jun 21 07:47:51 2022 -0400
Javadoc
---
.../apache/commons/io/input/XmlStreamReader.java | 91 --
1 file changed, 68 insertions(+), 23 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
index 5a490bfe..d1e39f49 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -71,6 +71,7 @@ import org.apache.commons.io.IOUtils;
* @since 2.0
*/
public class XmlStreamReader extends Reader {
+
private static final String UTF_8 = "UTF-8";
private static final String US_ASCII = "US-ASCII";
@@ -135,7 +136,7 @@ public class XmlStreamReader extends Reader {
"Invalid encoding, CT-MIME [{0}] CT-Enc [{1}] BOM [{2}] XML guess
[{3}] XML prolog [{4}], Invalid MIME";
/**
- * Returns charset parameter value, NULL if not present, NULL if
+ * Gets the charset parameter value, NULL if not present, NULL if
* httpContentType is NULL.
*
* @param httpContentType the HTTP content type
@@ -156,7 +157,7 @@ public class XmlStreamReader extends Reader {
}
/**
- * Returns MIME type or NULL if httpContentType is NULL.
+ * Gets the MIME type or NULL if httpContentType is NULL.
*
* @param httpContentType the HTTP content type
* @return The mime content type
@@ -176,7 +177,7 @@ public class XmlStreamReader extends Reader {
}
/**
- * Returns the encoding declared in the , NULL if none.
+ * Gets the encoding declared in the , NULL if none.
*
* @param inputStream InputStream to create the reader from.
* @param guessedEnc guessed encoding
@@ -230,7 +231,7 @@ public class XmlStreamReader extends Reader {
}
/**
- * Indicates if the MIME type belongs to the APPLICATION XML family.
+ * Tests if the MIME type belongs to the APPLICATION XML family.
*
* @param mime The mime type
* @return true if the mime type belongs to the APPLICATION XML family,
@@ -241,11 +242,11 @@ public class XmlStreamReader extends Reader {
(mime.equals("application/xml") ||
mime.equals("application/xml-dtd") ||
mime.equals("application/xml-external-parsed-entity") ||
- mime.startsWith("application/") && mime.endsWith("+xml"));
+mime.startsWith("application/") && mime.endsWith("+xml"));
}
/**
- * Indicates if the MIME type belongs to the TEXT XML family.
+ * Tests if the MIME type belongs to the TEXT XML family.
*
* @param mime The mime type
* @return true if the mime type belongs to the TEXT XML family,
@@ -255,7 +256,7 @@ public class XmlStreamReader extends Reader {
return mime != null &&
(mime.equals("text/xml") ||
mime.equals("text/xml-external-parsed-entity") ||
- mime.startsWith("text/") && mime.endsWith("+xml"));
+ mime.startsWith("text/") && mime.endsWith("+xml"));
}
private final Reader reader;
@@ -265,13 +266,15 @@ public class XmlStreamReader extends Reader {
private final String defaultEncoding;
/**
- * Creates a Reader for a File.
+ * Constructs a Reader for a File.
*
* It looks for the UTF-8 BOM first, if none sniffs the XML prolog charset,
* if this is also missing defaults to UTF-8.
+ *
*
* It does a lenient charset encoding detection, check the constructor with
* the lenient parameter for details.
+ *
*
* @param file File to create a Reader from.
* @throws IOException thrown if there is a problem reading the file.
@@ -281,12 +284,14 @@ public class XmlStreamReader extends Reader {
}
/**
- * Creates a Reader for a raw InputStream.
+ * Constructs a Reader for a raw InputStream.
*
* It follows the same logic used for files.
+ *
*
* It does a lenient charset encoding detection, check the constructor with
* the lenient parameter for details.
+ *
*
* @param inputStream InputStream to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream.
@@ -296,24 +301,31 @@ public class XmlStreamReader extends Reader {
}
/**
- * Creates a Reader for a raw InputStream.
+ * Constructs a Reader for a raw InputStream.
*
* It follows the same logic used for files.
+ *
*
* If
[commons-io] branch master updated: Javadoc
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 f2ee0df4 Javadoc
f2ee0df4 is described below
commit f2ee0df41f31bebc2694e55954e8dfd2e9787603
Author: Gary Gregory
AuthorDate: Tue Jun 21 07:40:54 2022 -0400
Javadoc
---
.../input/MessageDigestCalculatingInputStream.java | 42 +++---
1 file changed, 29 insertions(+), 13 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
index 324f4381..5f3d54dd 100644
---
a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
@@ -24,16 +24,26 @@ import java.security.Provider;
/**
- * This class is an example for using an {@link ObservableInputStream}. It
- * creates its own {@link
org.apache.commons.io.input.ObservableInputStream.Observer},
- * which calculates a checksum using a MessageDigest, for example an MD5 sum.
- * Note: Neither {@link ObservableInputStream}, nor {@link
MessageDigest},
- * are thread safe. So is {@link MessageDigestCalculatingInputStream}.
+ * This class is an example for using an {@link ObservableInputStream}. It
creates its own
+ * {@link org.apache.commons.io.input.ObservableInputStream.Observer}, which
calculates a checksum using a
+ * MessageDigest, for example an MD5 sum.
+ *
+ * See the MessageDigest section in the
+ * https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest;>
Java
+ * Cryptography Architecture Standard Algorithm Name Documentation for
information about standard algorithm names.
+ *
+ *
+ * Note: Neither {@link ObservableInputStream}, nor {@link
MessageDigest}, are thread safe. So is
+ * {@link MessageDigestCalculatingInputStream}.
+ *
*/
public class MessageDigestCalculatingInputStream extends ObservableInputStream
{
/**
* The default message digest algorithm.
+ *
+ * The MD5 cryptographic algorithm is weak and should not be used.
+ *
*/
private static final String DEFAULT_ALGORITHM = "MD5";
@@ -68,7 +78,7 @@ public class MessageDigestCalculatingInputStream extends
ObservableInputStream {
* Creates a new instance, which calculates a signature on the given
stream, using a {@link MessageDigest} with the
* "MD5" algorithm.
*
- * The MD5 algorithm is weak and should not be used.
+ * The MD5 algorithm is weak and should not be used.
*
*
* @param inputStream the stream to calculate the message digest for
@@ -79,7 +89,8 @@ public class MessageDigestCalculatingInputStream extends
ObservableInputStream {
this(inputStream, getDefaultMessageDigest());
}
-/** Creates a new instance, which calculates a signature on the given
stream,
+/**
+ * Creates a new instance, which calculates a signature on the given
stream,
* using the given {@link MessageDigest}.
* @param inputStream the stream to calculate the message digest for
* @param messageDigest the message digest to use
@@ -94,7 +105,10 @@ public class MessageDigestCalculatingInputStream extends
ObservableInputStream {
* given algorithm.
*
* @param inputStream the stream to calculate the message digest for
- * @param algorithm the name of the algorithm to use
+ * @param algorithm the name of the algorithm requested. See the
MessageDigest section in the
+ *https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest;>
+ *Java Cryptography Architecture Standard Algorithm Name
Documentation for information about standard
+ *algorithm names.
* @throws NoSuchAlgorithmException if no Provider supports a
MessageDigestSpi implementation for the specified
* algorithm.
*/
@@ -104,24 +118,26 @@ public class MessageDigestCalculatingInputStream extends
ObservableInputStream {
}
/**
- * Gets a MessageDigest object that implements the a digest algorithm.
- *
- * @return a Message Digest object that implements the specified algorithm.
+ * Gets a MessageDigest object that implements the default digest
algorithm.
*
+ * @return a Message Digest object that implements the default algorithm.
* @throws NoSuchAlgorithmException if no Provider supports a
MessageDigestSpi implementation.
- *
* @see Provider
*/
static MessageDigest getDefaultMessageDigest() throws
NoSuchAlgorithmException {
return MessageDigest.getInstance(DEFAULT_ALGORITHM);
}
-/** Returns the {@link MessageDigest}, which is being used for generating
[commons-io] branch master updated: Javadoc
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 9d221a22 Javadoc
9d221a22 is described below
commit 9d221a222f605f4feb8828efbda95de75bd352f9
Author: Gary Gregory
AuthorDate: Mon Jun 20 14:02:54 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/EndianUtils.java | 14 +-
1 file changed, 5 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/EndianUtils.java
b/src/main/java/org/apache/commons/io/EndianUtils.java
index f7e21915..9ce2281c 100644
--- a/src/main/java/org/apache/commons/io/EndianUtils.java
+++ b/src/main/java/org/apache/commons/io/EndianUtils.java
@@ -55,8 +55,6 @@ public class EndianUtils {
return value;
}
-// == Swapping routines
-
/**
* Reads a "double" value from a byte array at a given offset. The value is
* converted to the opposed endian system while reading.
@@ -102,7 +100,7 @@ public class EndianUtils {
}
/**
- * Reads a "int" value from a byte array at a given offset. The value is
+ * Reads an "int" value from a byte array at a given offset. The value is
* converted to the opposed endian system while reading.
* @param data source byte array
* @param offset starting offset in the byte array
@@ -115,10 +113,8 @@ public class EndianUtils {
( ( data[ offset + 3 ] & 0xff ) << 24 );
}
-// == Swapping read/write routines
-
/**
- * Reads a "int" value from an InputStream. The value is
+ * Reads an "int" value from an InputStream. The value is
* converted to the opposed endian system while reading.
* @param input source InputStream
* @return the value just read
@@ -268,7 +264,7 @@ public class EndianUtils {
}
/**
- * Converts a "int" value between endian systems.
+ * Converts an "int" value between endian systems.
* @param value value to convert
* @return the converted value
*/
@@ -352,7 +348,7 @@ public class EndianUtils {
}
/**
- * Writes a "int" value to a byte array at a given offset. The value is
+ * Writes an "int" value to a byte array at a given offset. The value is
* converted to the opposed endian system while writing.
* @param data target byte array
* @param offset starting offset in the byte array
@@ -366,7 +362,7 @@ public class EndianUtils {
}
/**
- * Writes a "int" value to an OutputStream. The value is converted to the
opposed endian system while writing.
+ * Writes an "int" value to an OutputStream. The value is converted to the
opposed endian system while writing.
*
* @param output target OutputStream
* @param value value to write
[commons-io] branch master updated: Javadoc
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 c639fb35 Javadoc
c639fb35 is described below
commit c639fb350922c89495f6756a7babeee33d628dd6
Author: Gary Gregory
AuthorDate: Wed Jun 15 15:27:58 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/Tailer.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/Tailer.java
b/src/main/java/org/apache/commons/io/input/Tailer.java
index 57b34988..6771c158 100644
--- a/src/main/java/org/apache/commons/io/input/Tailer.java
+++ b/src/main/java/org/apache/commons/io/input/Tailer.java
@@ -205,7 +205,7 @@ public class Tailer implements Runnable, AutoCloseable {
}
/**
- * Builds a new configured instance.
+ * Builds and starts a new configured instance.
*
* @return a new configured instance.
*/
[commons-io] branch master updated: Javadoc: Don't use FQCN in throws clause.
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 13258ce2 Javadoc: Don't use FQCN in throws clause.
13258ce2 is described below
commit 13258ce2d07aa0e764bbaa8020af4dcd3a02a620
Author: Gary Gregory
AuthorDate: Sat May 21 15:27:36 2022 -0400
Javadoc: Don't use FQCN in throws clause.
---
src/main/java/org/apache/commons/io/input/Tailer.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/Tailer.java
b/src/main/java/org/apache/commons/io/input/Tailer.java
index 6b26474e..57b34988 100644
--- a/src/main/java/org/apache/commons/io/input/Tailer.java
+++ b/src/main/java/org/apache/commons/io/input/Tailer.java
@@ -835,7 +835,7 @@ public class Tailer implements Runnable, AutoCloseable {
*
* @param reader The file to read
* @return The new position after the lines have been read
- * @throws java.io.IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs.
*/
private long readLines(final RandomAccessResourceBridge reader) throws
IOException {
try (ByteArrayOutputStream lineBuf = new ByteArrayOutputStream(64)) {
[commons-io] branch master updated: Javadoc.
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 913639da Javadoc.
913639da is described below
commit 913639da3f08178fae4f0fede76dcb7d9a25cc1d
Author: Gary Gregory
AuthorDate: Tue May 10 13:53:38 2022 -0400
Javadoc.
---
src/test/java/org/apache/commons/io/function/IOFunctionTest.java | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
b/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
index 9b7b4316..82f90c8e 100644
--- a/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
+++ b/src/test/java/org/apache/commons/io/function/IOFunctionTest.java
@@ -29,6 +29,9 @@ import java.util.function.Supplier;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link IOFunction}.
+ */
public class IOFunctionTest {
private static class Holder {
[commons-io] branch master updated: Javadoc.
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 60319bd Javadoc.
60319bd is described below
commit 60319bd7332a3ca2e40d621e31db0dd0417be311
Author: Gary Gregory
AuthorDate: Sun Feb 13 11:31:33 2022 -0500
Javadoc.
---
.../java/org/apache/commons/io/comparator/AbstractFileComparator.java | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/comparator/AbstractFileComparator.java
b/src/main/java/org/apache/commons/io/comparator/AbstractFileComparator.java
index 52cb526..64148a5 100644
--- a/src/main/java/org/apache/commons/io/comparator/AbstractFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/AbstractFileComparator.java
@@ -18,7 +18,6 @@ package org.apache.commons.io.comparator;
import java.io.File;
import java.util.Arrays;
-import java.util.Collections;
import java.util.Comparator;
import java.util.List;
@@ -49,7 +48,7 @@ abstract class AbstractFileComparator implements
Comparator {
/**
* Sorts a List of files.
*
- * This method uses {@link Collections#sort(List, Comparator)} and returns
the original list.
+ * This method uses {@link List#sort(Comparator)} and returns the original
list.
*
*
* @param files The files to sort, may be null.
[commons-io] branch master updated: Javadoc.
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 8bb7a31 Javadoc.
8bb7a31 is described below
commit 8bb7a3144abce26ca54e218449e5095348b74b2f
Author: Gary Gregory
AuthorDate: Sun Feb 6 17:16:36 2022 -0500
Javadoc.
---
.../org/apache/commons/io/input/CountingInputStream.java | 12
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/CountingInputStream.java
b/src/main/java/org/apache/commons/io/input/CountingInputStream.java
index 7054b8f..4b706f2 100644
--- a/src/main/java/org/apache/commons/io/input/CountingInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CountingInputStream.java
@@ -58,11 +58,12 @@ public class CountingInputStream extends ProxyInputStream {
}
/**
- * The number of bytes that have passed through this stream.
+ * Gets number of bytes that have passed through this stream.
*
* NOTE: This method is an alternative for {@code getCount()}
* and was added because that method returns an integer which will
* result in incorrect count for files over 2GB.
+ *
*
* @return the number of bytes accumulated
* @since 1.3
@@ -72,11 +73,12 @@ public class CountingInputStream extends ProxyInputStream {
}
/**
- * The number of bytes that have passed through this stream.
+ * Gets number of bytes that have passed through this stream.
*
* NOTE: From v1.3 this method throws an ArithmeticException if the
* count is greater than can be expressed by an {@code int}.
* See {@link #getByteCount()} for a method using a {@code long}.
+ *
*
* @return the number of bytes accumulated
* @throws ArithmeticException if the byte count is too large
@@ -90,11 +92,12 @@ public class CountingInputStream extends ProxyInputStream {
}
/**
- * Set the byte count back to 0.
+ * Resets the byte count back to 0.
*
* NOTE: This method is an alternative for {@code resetCount()}
* and was added because that method returns an integer which will
* result in incorrect count for files over 2GB.
+ *
*
* @return the count previous to resetting
* @since 1.3
@@ -106,11 +109,12 @@ public class CountingInputStream extends ProxyInputStream
{
}
/**
- * Set the byte count back to 0.
+ * Resets the byte count back to 0.
*
* NOTE: From v1.3 this method throws an ArithmeticException if the
* count is greater than can be expressed by an {@code int}.
* See {@link #resetByteCount()} for a method using a {@code long}.
+ *
*
* @return the count previous to resetting
* @throws ArithmeticException if the byte count is too large
[commons-io] branch master updated: Javadoc.
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 a8ae408 Javadoc.
a8ae408 is described below
commit a8ae408b28dcd867af6b531cf73925458abdde52
Author: Gary Gregory
AuthorDate: Mon Dec 6 22:34:43 2021 -0500
Javadoc.
---
src/main/java/org/apache/commons/io/RandomAccessFileMode.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
index 44816e8..f928e58 100644
--- a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
+++ b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
@@ -22,7 +22,7 @@ import java.io.RandomAccessFile;
import java.nio.file.Path;
/**
- * Access modes and factory for {@link RandomAccessFile}.
+ * Access modes and factory methods for {@link RandomAccessFile}.
*
* @since 2.12.0
*/
[commons-io] branch master updated: Javadoc.
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 a15f294 Javadoc.
a15f294 is described below
commit a15f294c3a0fce84ba37101b1199a330ebc3d70c
Author: Gary Gregory
AuthorDate: Mon Dec 6 22:21:37 2021 -0500
Javadoc.
---
src/main/java/org/apache/commons/io/RandomAccessFileMode.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
index 98fe099..44816e8 100644
--- a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
+++ b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
@@ -22,7 +22,7 @@ import java.io.RandomAccessFile;
import java.nio.file.Path;
/**
- * Modes and factory for {@link RandomAccessFile}.
+ * Access modes and factory for {@link RandomAccessFile}.
*
* @since 2.12.0
*/
[commons-io] branch master updated: Javadoc.
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 ff38701 Javadoc.
ff38701 is described below
commit ff387016c2d95162aa6bf6735be47c559751b530
Author: Gary Gregory
AuthorDate: Fri Dec 3 08:53:58 2021 -0500
Javadoc.
---
.../apache/commons/io/input/BufferedFileChannelInputStream.java| 1 +
.../java/org/apache/commons/io/input/ReadAheadInputStream.java | 7 ++-
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
index f9e6ad7..80c6306 100644
---
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
@@ -157,6 +157,7 @@ public final class BufferedFileChannelInputStream extends
InputStream {
* Checks whether data is left to be read from the input stream.
*
* @return true if data is left, false otherwise
+ * @throws IOException if an I/O error occurs.
*/
private boolean refill() throws IOException {
if (!byteBuffer.hasRemaining()) {
diff --git
a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
index d1cddd8..4d34357 100644
--- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
@@ -283,7 +283,11 @@ public class ReadAheadInputStream extends InputStream {
return len;
}
-/** Read data from underlyingInputStream to readAheadBuffer
asynchronously. */
+/**
+ * Read data from underlyingInputStream to readAheadBuffer asynchronously.
+ *
+ * @throws IOException if an I/O error occurs.
+ */
private void readAsync() throws IOException {
stateChangeLock.lock();
final byte[] arr;
@@ -398,6 +402,7 @@ public class ReadAheadInputStream extends InputStream {
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
+ * @throws IOException if an I/O error occurs.
*/
private long skipInternal(final long n) throws IOException {
assert stateChangeLock.isLocked();
[commons-io] branch master updated: Javadoc.
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 dbc2de2 Javadoc.
dbc2de2 is described below
commit dbc2de2b5301763068b960c17410fd21f3b2dcdb
Author: Gary Gregory
AuthorDate: Fri Dec 3 08:50:41 2021 -0500
Javadoc.
---
src/main/java/org/apache/commons/io/FileUtils.java | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java
b/src/main/java/org/apache/commons/io/FileUtils.java
index 84cbfbf..f042cc6 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -2676,6 +2676,7 @@ public class FileUtils {
*
* @param file1 The first file to compare.
* @param file2 The second file to compare.
+ * @throws IOException if an I/O error occurs.
* @throws IllegalArgumentException if the given files' canonical
representations are equal.
*/
private static void requireCanonicalPathsNotEquals(final File file1, final
File file2) throws IOException {
