You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/07/09 14:57:08 UTC
[commons-io] branch master updated (50d8e9c3 -> 0f2c3bc1)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
from 50d8e9c3 Fix formatting
new 18e1b6e0 More testing
new ba967e37 Test should generate temporary files in the Maven "target" folder instead of the root
new 5035e97f Add ThresholdingOutputStream.getOutputStream() and deprecate getStream()
new 0f2c3bc1 Javadoc
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/changes/changes.xml | 3 +++
.../org/apache/commons/io/IOExceptionList.java | 4 ++--
.../org/apache/commons/io/IOIndexedException.java | 2 +-
.../apache/commons/io/RandomAccessFileMode.java | 6 ++---
.../org/apache/commons/io/TaggedIOException.java | 2 +-
.../apache/commons/io/UncheckedIOExceptions.java | 4 ++--
.../commons/io/build/AbstractOriginSupplier.java | 22 ++++++++---------
.../commons/io/file/AccumulatorPathVisitor.java | 8 +++----
.../commons/io/file/CleaningPathVisitor.java | 4 ++--
.../commons/io/file/CountingPathVisitor.java | 4 ++--
.../commons/io/file/DeletingPathVisitor.java | 4 ++--
.../apache/commons/io/filefilter/IOFileFilter.java | 6 ++---
.../apache/commons/io/function/IOBaseStream.java | 2 +-
.../apache/commons/io/function/IOSpliterator.java | 2 +-
.../org/apache/commons/io/function/Uncheck.java | 4 ++--
.../commons/io/input/AutoCloseInputStream.java | 2 +-
.../apache/commons/io/input/BrokenInputStream.java | 6 ++---
.../org/apache/commons/io/input/BrokenReader.java | 6 ++---
.../commons/io/input/CircularInputStream.java | 2 +-
.../commons/io/input/CloseShieldInputStream.java | 4 ++--
.../apache/commons/io/input/CloseShieldReader.java | 4 ++--
.../io/input/InfiniteCircularInputStream.java | 2 +-
.../commons/io/input/MarkShieldInputStream.java | 2 +-
.../input/MessageDigestCalculatingInputStream.java | 8 +++----
.../org/apache/commons/io/input/NullReader.java | 6 ++---
.../commons/io/input/ObservableInputStream.java | 6 ++---
.../apache/commons/io/input/QueueInputStream.java | 2 +-
.../commons/io/input/ReadAheadInputStream.java | 10 ++++----
.../commons/io/input/ReversedLinesFileReader.java | 16 ++++++-------
.../apache/commons/io/input/TaggedInputStream.java | 2 +-
.../org/apache/commons/io/input/TaggedReader.java | 2 +-
.../apache/commons/io/input/TeeInputStream.java | 4 ++--
.../org/apache/commons/io/input/TeeReader.java | 4 ++--
.../commons/io/input/UncheckedBufferedReader.java | 2 +-
.../io/input/UncheckedFilterInputStream.java | 2 +-
.../commons/io/input/UncheckedFilterReader.java | 2 +-
.../io/input/UnixLineEndingInputStream.java | 2 +-
.../io/input/UnsupportedOperationExceptions.java | 6 ++---
.../input/UnsynchronizedByteArrayInputStream.java | 6 ++---
.../io/input/WindowsLineEndingInputStream.java | 2 +-
.../commons/io/input/XmlStreamReaderException.java | 4 ++--
.../io/input/buffer/CircularBufferInputStream.java | 4 ++--
.../io/input/buffer/CircularByteBuffer.java | 4 ++--
.../io/input/buffer/PeekableInputStream.java | 4 ++--
.../org/apache/commons/io/monitor/FileEntry.java | 2 +-
.../commons/io/output/BrokenOutputStream.java | 6 ++---
.../org/apache/commons/io/output/BrokenWriter.java | 6 ++---
.../commons/io/output/ByteArrayOutputStream.java | 4 ++--
.../commons/io/output/ChunkedOutputStream.java | 4 ++--
.../apache/commons/io/output/ChunkedWriter.java | 7 +++---
.../commons/io/output/CloseShieldOutputStream.java | 4 ++--
.../commons/io/output/CloseShieldWriter.java | 4 ++--
.../commons/io/output/CountingOutputStream.java | 6 ++++-
.../commons/io/output/FilterCollectionWriter.java | 4 ++--
.../commons/io/output/ProxyCollectionWriter.java | 4 ++--
.../commons/io/output/QueueOutputStream.java | 2 +-
.../commons/io/output/TaggedOutputStream.java | 2 +-
.../org/apache/commons/io/output/TaggedWriter.java | 2 +-
.../org/apache/commons/io/output/TeeWriter.java | 4 ++--
.../io/output/ThresholdingOutputStream.java | 28 ++++++++++++++++++----
.../commons/io/output/UncheckedAppendable.java | 2 +-
.../io/output/UncheckedFilterOutputStream.java | 2 +-
.../commons/io/output/UncheckedFilterWriter.java | 2 +-
.../UnsynchronizedByteArrayOutputStream.java | 4 ++--
.../io/output/DeferredFileOutputStreamTest.java | 19 ++++++++++++---
.../io/output/ThresholdingOutputStreamTest.java | 27 ++++++++++++++++++++-
66 files changed, 206 insertions(+), 142 deletions(-)
[commons-io] 01/04: More testing
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit 18e1b6e000479bad57054eb42ddfa2a90bf77401
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jul 9 09:13:33 2023 -0400
More testing
---
.../commons/io/output/DeferredFileOutputStreamTest.java | 12 ++++++++++++
1 file changed, 12 insertions(+)
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 8b01b5c8..8ee317f8 100644
--- a/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
@@ -80,6 +80,7 @@ public class DeferredFileOutputStreamTest {
dfos.close();
assertFalse(dfos.isInMemory());
assertNull(dfos.getData());
+ assertEquals(testFile.length(), dfos.getByteCount());
verifyResultFile(testFile);
@@ -107,6 +108,7 @@ public class DeferredFileOutputStreamTest {
dfos.write(testBytes, 0, testBytes.length);
dfos.close();
assertFalse(dfos.isInMemory());
+ assertEquals(testFile.length(), dfos.getByteCount());
try (InputStream is = dfos.toInputStream()) {
assertArrayEquals(testBytes, IOUtils.toByteArray(is));
@@ -131,6 +133,7 @@ public class DeferredFileOutputStreamTest {
dfos.write(testBytes, 0, testBytes.length);
dfos.close();
assertTrue(dfos.isInMemory());
+ assertEquals(testBytes.length, dfos.getByteCount());
final byte[] resultBytes = dfos.getData();
assertEquals(testBytes.length, resultBytes.length);
@@ -153,6 +156,7 @@ public class DeferredFileOutputStreamTest {
dfos.write(testBytes, 0, testBytes.length);
dfos.close();
assertTrue(dfos.isInMemory());
+ assertEquals(testBytes.length, dfos.getByteCount());
final byte[] resultBytes = dfos.getData();
assertEquals(testBytes.length, resultBytes.length);
@@ -175,6 +179,7 @@ public class DeferredFileOutputStreamTest {
dfos.write(testBytes, 0, testBytes.length);
dfos.close();
assertTrue(dfos.isInMemory());
+ assertEquals(testBytes.length, dfos.getByteCount());
try (InputStream is = dfos.toInputStream()) {
assertArrayEquals(testBytes, IOUtils.toByteArray(is));
@@ -205,6 +210,7 @@ public class DeferredFileOutputStreamTest {
dfos.write(testBytes, 0, testBytes.length);
dfos.close();
assertFalse(dfos.isInMemory());
+ assertEquals(testBytes.length, dfos.getByteCount());
assertNull(dfos.getData());
assertNotNull(dfos.getFile(), "Check file not null");
assertTrue(dfos.getFile().exists(), "Check file exists");
@@ -244,6 +250,7 @@ public class DeferredFileOutputStreamTest {
dfos.close();
assertFalse(dfos.isInMemory());
assertNull(dfos.getData());
+ assertEquals(testBytes.length, dfos.getByteCount());
assertNotNull(dfos.getFile(), "Check file not null");
assertTrue(dfos.getFile().exists(), "Check file exists");
assertTrue(dfos.getFile().getName().startsWith(prefix), "Check prefix");
@@ -272,6 +279,7 @@ public class DeferredFileOutputStreamTest {
dfos.write(testBytes, 0, testBytes.length);
dfos.close();
assertTrue(dfos.isInMemory());
+ assertEquals(testBytes.length, dfos.getByteCount());
assertNull(dfos.getFile(), "Check file is null-B");
}
@@ -315,6 +323,7 @@ public class DeferredFileOutputStreamTest {
dfos.close();
assertFalse(dfos.isInMemory());
assertNull(dfos.getData());
+ assertEquals(testBytes.length, dfos.getByteCount());
verifyResultFile(testFile);
@@ -338,6 +347,7 @@ public class DeferredFileOutputStreamTest {
assertTrue(testFile.exists());
assertFalse(dfos.isInMemory());
+ assertEquals(testBytes.length, dfos.getByteCount());
assertThrows(IOException.class, () -> dfos.writeTo(baos));
@@ -367,6 +377,7 @@ public class DeferredFileOutputStreamTest {
assertFalse(dfos.isInMemory());
assertThrows(IOException.class, () -> dfos.writeTo(baos));
+ assertEquals(testBytes.length, dfos.getByteCount());
dfos.close();
dfos.writeTo(baos);
@@ -395,6 +406,7 @@ public class DeferredFileOutputStreamTest {
assertTrue(dfos.isInMemory());
assertThrows(IOException.class, () -> dfos.writeTo(baos));
+ assertEquals(testBytes.length, dfos.getByteCount());
dfos.close();
dfos.writeTo(baos);
[commons-io] 04/04: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit 0f2c3bc176a303ab47647d3a0d46019ddd3939de
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jul 9 10:57:01 2023 -0400
Javadoc
---
.../org/apache/commons/io/IOExceptionList.java | 4 ++--
.../org/apache/commons/io/IOIndexedException.java | 2 +-
.../apache/commons/io/RandomAccessFileMode.java | 6 +++---
.../org/apache/commons/io/TaggedIOException.java | 2 +-
.../apache/commons/io/UncheckedIOExceptions.java | 4 ++--
.../commons/io/build/AbstractOriginSupplier.java | 22 +++++++++++-----------
.../commons/io/file/AccumulatorPathVisitor.java | 8 ++++----
.../commons/io/file/CleaningPathVisitor.java | 4 ++--
.../commons/io/file/CountingPathVisitor.java | 4 ++--
.../commons/io/file/DeletingPathVisitor.java | 4 ++--
.../apache/commons/io/filefilter/IOFileFilter.java | 6 +++---
.../apache/commons/io/function/IOBaseStream.java | 2 +-
.../apache/commons/io/function/IOSpliterator.java | 2 +-
.../org/apache/commons/io/function/Uncheck.java | 4 ++--
.../commons/io/input/AutoCloseInputStream.java | 2 +-
.../apache/commons/io/input/BrokenInputStream.java | 6 +++---
.../org/apache/commons/io/input/BrokenReader.java | 6 +++---
.../commons/io/input/CircularInputStream.java | 2 +-
.../commons/io/input/CloseShieldInputStream.java | 4 ++--
.../apache/commons/io/input/CloseShieldReader.java | 4 ++--
.../io/input/InfiniteCircularInputStream.java | 2 +-
.../commons/io/input/MarkShieldInputStream.java | 2 +-
.../input/MessageDigestCalculatingInputStream.java | 8 ++++----
.../org/apache/commons/io/input/NullReader.java | 6 +++---
.../commons/io/input/ObservableInputStream.java | 6 +++---
.../apache/commons/io/input/QueueInputStream.java | 2 +-
.../commons/io/input/ReadAheadInputStream.java | 10 +++++-----
.../commons/io/input/ReversedLinesFileReader.java | 16 ++++++++--------
.../apache/commons/io/input/TaggedInputStream.java | 2 +-
.../org/apache/commons/io/input/TaggedReader.java | 2 +-
.../apache/commons/io/input/TeeInputStream.java | 4 ++--
.../org/apache/commons/io/input/TeeReader.java | 4 ++--
.../commons/io/input/UncheckedBufferedReader.java | 2 +-
.../io/input/UncheckedFilterInputStream.java | 2 +-
.../commons/io/input/UncheckedFilterReader.java | 2 +-
.../io/input/UnixLineEndingInputStream.java | 2 +-
.../io/input/UnsupportedOperationExceptions.java | 6 +++---
.../input/UnsynchronizedByteArrayInputStream.java | 6 +++---
.../io/input/WindowsLineEndingInputStream.java | 2 +-
.../commons/io/input/XmlStreamReaderException.java | 4 ++--
.../io/input/buffer/CircularBufferInputStream.java | 4 ++--
.../io/input/buffer/CircularByteBuffer.java | 4 ++--
.../io/input/buffer/PeekableInputStream.java | 4 ++--
.../org/apache/commons/io/monitor/FileEntry.java | 2 +-
.../commons/io/output/BrokenOutputStream.java | 6 +++---
.../org/apache/commons/io/output/BrokenWriter.java | 6 +++---
.../commons/io/output/ByteArrayOutputStream.java | 4 ++--
.../commons/io/output/ChunkedOutputStream.java | 4 ++--
.../apache/commons/io/output/ChunkedWriter.java | 7 ++++---
.../commons/io/output/CloseShieldOutputStream.java | 4 ++--
.../commons/io/output/CloseShieldWriter.java | 4 ++--
.../commons/io/output/CountingOutputStream.java | 6 +++++-
.../commons/io/output/FilterCollectionWriter.java | 4 ++--
.../commons/io/output/ProxyCollectionWriter.java | 4 ++--
.../commons/io/output/QueueOutputStream.java | 2 +-
.../commons/io/output/TaggedOutputStream.java | 2 +-
.../org/apache/commons/io/output/TaggedWriter.java | 2 +-
.../org/apache/commons/io/output/TeeWriter.java | 4 ++--
.../io/output/ThresholdingOutputStream.java | 6 +++---
.../commons/io/output/UncheckedAppendable.java | 2 +-
.../io/output/UncheckedFilterOutputStream.java | 2 +-
.../commons/io/output/UncheckedFilterWriter.java | 2 +-
.../UnsynchronizedByteArrayOutputStream.java | 4 ++--
63 files changed, 141 insertions(+), 136 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOExceptionList.java b/src/main/java/org/apache/commons/io/IOExceptionList.java
index ca3f8800..8ee519b5 100644
--- a/src/main/java/org/apache/commons/io/IOExceptionList.java
+++ b/src/main/java/org/apache/commons/io/IOExceptionList.java
@@ -65,7 +65,7 @@ public class IOExceptionList extends IOException implements Iterable<Throwable>
private final List<? extends Throwable> causeList;
/**
- * Creates a new exception caused by a list of exceptions.
+ * Constructs a new exception caused by a list of exceptions.
*
* @param causeList a list of cause exceptions.
*/
@@ -74,7 +74,7 @@ public class IOExceptionList extends IOException implements Iterable<Throwable>
}
/**
- * Creates a new exception caused by a list of exceptions.
+ * Constructs a new exception caused by a list of exceptions.
*
* @param message The detail message, see {@link #getMessage()}.
* @param causeList a list of cause exceptions.
diff --git a/src/main/java/org/apache/commons/io/IOIndexedException.java b/src/main/java/org/apache/commons/io/IOIndexedException.java
index 71253d43..9a85328e 100644
--- a/src/main/java/org/apache/commons/io/IOIndexedException.java
+++ b/src/main/java/org/apache/commons/io/IOIndexedException.java
@@ -45,7 +45,7 @@ public class IOIndexedException extends IOException {
private final int index;
/**
- * Creates a new exception.
+ * Constructs a new exception.
*
* @param index index of this exception.
* @param cause cause exceptions.
diff --git a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
index bb2c1236..54061588 100644
--- a/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
+++ b/src/main/java/org/apache/commons/io/RandomAccessFileMode.java
@@ -57,7 +57,7 @@ public enum RandomAccessFileMode {
}
/**
- * Creates a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
+ * Constructs a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
* argument.
*
* @param file the file object
@@ -69,7 +69,7 @@ public enum RandomAccessFileMode {
}
/**
- * Creates a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
+ * Constructs a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
* argument.
*
* @param file the file object
@@ -81,7 +81,7 @@ public enum RandomAccessFileMode {
}
/**
- * Creates a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
+ * Constructs a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
* argument.
*
* @param file the file object
diff --git a/src/main/java/org/apache/commons/io/TaggedIOException.java b/src/main/java/org/apache/commons/io/TaggedIOException.java
index 43d7730f..9c95d326 100644
--- a/src/main/java/org/apache/commons/io/TaggedIOException.java
+++ b/src/main/java/org/apache/commons/io/TaggedIOException.java
@@ -103,7 +103,7 @@ public class TaggedIOException extends IOExceptionWithCause {
private final Serializable tag;
/**
- * Creates a tagged wrapper for the given exception.
+ * Constructs a tagged wrapper for the given exception.
*
* @param original the exception to be tagged
* @param tag tag of this exception
diff --git a/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java b/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java
index 797213ff..97271af6 100644
--- a/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java
+++ b/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java
@@ -29,7 +29,7 @@ import java.util.Objects;
final class UncheckedIOExceptions {
/**
- * Creates a new UncheckedIOException for the given detail message.
+ * Constructs a new UncheckedIOException for the given detail message.
* <p>
* This method exists because there is no String constructor in {@link UncheckedIOException}.
* </p>
@@ -43,7 +43,7 @@ final class UncheckedIOExceptions {
}
/**
- * Creates a new UncheckedIOException for the given detail message.
+ * Constructs a new UncheckedIOException for the given detail message.
* <p>
* This method exists because there is no String constructor in {@link UncheckedIOException}.
* </p>
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 bc79dba5..bd823713 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
@@ -46,7 +46,7 @@ import org.apache.commons.io.build.AbstractOrigin.WriterOrigin;
public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier<T, B>> extends AbstractSupplier<T, B> {
/**
- * Creates a new byte array origin for a byte array.
+ * Constructs a new byte array origin for a byte array.
*
* @param origin the byte array.
* @return a new byte array origin.
@@ -56,7 +56,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new CharSequence origin for a CharSequence.
+ * Constructs a new CharSequence origin for a CharSequence.
*
* @param origin the CharSequence.
* @return a new file origin.
@@ -67,7 +67,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new file origin for a file.
+ * Constructs a new file origin for a file.
*
* @param origin the file.
* @return a new file origin.
@@ -77,7 +77,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new file origin for a file path.
+ * Constructs a new file origin for a file path.
*
* @param origin the file path.
* @return a new file origin.
@@ -87,7 +87,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new input stream origin for a file.
+ * Constructs a new input stream origin for a file.
*
* @param origin the input stream.
* @return a new input stream origin.
@@ -97,7 +97,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new output stream origin for a file.
+ * Constructs a new output stream origin for a file.
*
* @param origin the output stream.
* @return a new output stream origin.
@@ -107,7 +107,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new path origin for a file.
+ * Constructs a new path origin for a file.
*
* @param origin the path.
* @return a new path origin.
@@ -117,7 +117,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new path name origin for a path name.
+ * Constructs a new path name origin for a path name.
*
* @param origin the path name.
* @return a new path name origin.
@@ -127,7 +127,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new reader origin for a reader.
+ * Constructs a new reader origin for a reader.
*
* @param origin the reader.
* @return a new reader origin.
@@ -137,7 +137,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new reader origin for a URI.
+ * Constructs a new reader origin for a URI.
*
* @param origin the URI.
* @return a new URI origin.
@@ -147,7 +147,7 @@ public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier
}
/**
- * Creates a new writer origin for a file.
+ * Constructs a new writer origin for a file.
*
* @param origin the writer.
* @return a new writer .
diff --git a/src/main/java/org/apache/commons/io/file/AccumulatorPathVisitor.java b/src/main/java/org/apache/commons/io/file/AccumulatorPathVisitor.java
index 0574ddd7..ecfdd2b7 100644
--- a/src/main/java/org/apache/commons/io/file/AccumulatorPathVisitor.java
+++ b/src/main/java/org/apache/commons/io/file/AccumulatorPathVisitor.java
@@ -61,7 +61,7 @@ import org.apache.commons.io.function.IOBiFunction;
public class AccumulatorPathVisitor extends CountingPathVisitor {
/**
- * Creates a new instance configured with a BigInteger {@link PathCounters}.
+ * Constructs a new instance configured with a BigInteger {@link PathCounters}.
*
* @return a new instance configured with a BigInteger {@link PathCounters}.
*/
@@ -70,7 +70,7 @@ public class AccumulatorPathVisitor extends CountingPathVisitor {
}
/**
- * Creates a new instance configured with a BigInteger {@link PathCounters}.
+ * Constructs a new instance configured with a BigInteger {@link PathCounters}.
*
* @param fileFilter Filters files to accumulate and count.
* @param dirFilter Filters directories to accumulate and count.
@@ -83,7 +83,7 @@ public class AccumulatorPathVisitor extends CountingPathVisitor {
}
/**
- * Creates a new instance configured with a long {@link PathCounters}.
+ * Constructs a new instance configured with a long {@link PathCounters}.
*
* @return a new instance configured with a long {@link PathCounters}.
*/
@@ -92,7 +92,7 @@ public class AccumulatorPathVisitor extends CountingPathVisitor {
}
/**
- * Creates a new instance configured with a long {@link PathCounters}.
+ * Constructs a new instance configured with a long {@link PathCounters}.
*
* @param fileFilter Filters files to accumulate and count.
* @param dirFilter Filters directories to accumulate and count.
diff --git a/src/main/java/org/apache/commons/io/file/CleaningPathVisitor.java b/src/main/java/org/apache/commons/io/file/CleaningPathVisitor.java
index a94cf633..79162f32 100644
--- a/src/main/java/org/apache/commons/io/file/CleaningPathVisitor.java
+++ b/src/main/java/org/apache/commons/io/file/CleaningPathVisitor.java
@@ -36,7 +36,7 @@ import org.apache.commons.io.file.Counters.PathCounters;
public class CleaningPathVisitor extends CountingPathVisitor {
/**
- * Creates a new instance configured with a BigInteger {@link PathCounters}.
+ * Constructs a new instance configured with a BigInteger {@link PathCounters}.
*
* @return a new instance configured with a BigInteger {@link PathCounters}.
*/
@@ -45,7 +45,7 @@ public class CleaningPathVisitor extends CountingPathVisitor {
}
/**
- * Creates a new instance configured with a long {@link PathCounters}.
+ * Constructs a new instance configured with a long {@link PathCounters}.
*
* @return a new instance configured with a long {@link PathCounters}.
*/
diff --git a/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java b/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java
index b841019d..00368ef9 100644
--- a/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java
+++ b/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java
@@ -49,7 +49,7 @@ public class CountingPathVisitor extends SimplePathVisitor {
}
/**
- * Creates a new instance configured with a {@link BigInteger} {@link PathCounters}.
+ * Constructs a new instance configured with a {@link BigInteger} {@link PathCounters}.
*
* @return a new instance configured with a {@link BigInteger} {@link PathCounters}.
*/
@@ -58,7 +58,7 @@ public class CountingPathVisitor extends SimplePathVisitor {
}
/**
- * Creates a new instance configured with a {@code long} {@link PathCounters}.
+ * Constructs a new instance configured with a {@code long} {@link PathCounters}.
*
* @return a new instance configured with a {@code long} {@link PathCounters}.
*/
diff --git a/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java b/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java
index 0d3b5334..aff9bcd3 100644
--- a/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java
+++ b/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java
@@ -37,7 +37,7 @@ import org.apache.commons.io.file.Counters.PathCounters;
public class DeletingPathVisitor extends CountingPathVisitor {
/**
- * Creates a new instance configured with a BigInteger {@link PathCounters}.
+ * Constructs a new instance configured with a BigInteger {@link PathCounters}.
*
* @return a new instance configured with a BigInteger {@link PathCounters}.
*/
@@ -46,7 +46,7 @@ public class DeletingPathVisitor extends CountingPathVisitor {
}
/**
- * Creates a new instance configured with a long {@link PathCounters}.
+ * Constructs a new instance configured with a long {@link PathCounters}.
*
* @return a new instance configured with a long {@link PathCounters}.
*/
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 f13b3adf..2bdeab49 100644
--- a/src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/IOFileFilter.java
@@ -76,7 +76,7 @@ public interface IOFileFilter extends FileFilter, FilenameFilter, PathFilter, Pa
}
/**
- * Creates a new "and" filter with this filter.
+ * Constructs a new "and" filter with this filter.
*
* @param fileFilter the filter to "and".
* @return a new filter.
@@ -99,7 +99,7 @@ public interface IOFileFilter extends FileFilter, FilenameFilter, PathFilter, Pa
}
/**
- * Creates a new "not" filter with this filter.
+ * Constructs a new "not" filter with this filter.
*
* @return a new filter.
* @since 2.9.0
@@ -109,7 +109,7 @@ public interface IOFileFilter extends FileFilter, FilenameFilter, PathFilter, Pa
}
/**
- * Creates a new "or" filter with this filter.
+ * Constructs a new "or" filter with this filter.
*
* @param fileFilter the filter to "or".
* @return a new filter.
diff --git a/src/main/java/org/apache/commons/io/function/IOBaseStream.java b/src/main/java/org/apache/commons/io/function/IOBaseStream.java
index 6ac9bee2..2048709e 100644
--- a/src/main/java/org/apache/commons/io/function/IOBaseStream.java
+++ b/src/main/java/org/apache/commons/io/function/IOBaseStream.java
@@ -34,7 +34,7 @@ import java.util.stream.Stream;
public interface IOBaseStream<T, S extends IOBaseStream<T, S, B>, B extends BaseStream<T, B>> extends Closeable {
/**
- * Creates a {@link BaseStream} for this instance that throws {@link UncheckedIOException} instead of
+ * Constructs a {@link BaseStream} for this instance that throws {@link UncheckedIOException} instead of
* {@link IOException}.
*
* @return an {@link UncheckedIOException} {@link BaseStream}.
diff --git a/src/main/java/org/apache/commons/io/function/IOSpliterator.java b/src/main/java/org/apache/commons/io/function/IOSpliterator.java
index e9031cd3..1e8dafa3 100644
--- a/src/main/java/org/apache/commons/io/function/IOSpliterator.java
+++ b/src/main/java/org/apache/commons/io/function/IOSpliterator.java
@@ -43,7 +43,7 @@ public interface IOSpliterator<T> {
}
/**
- * Creates a {@link Spliterator} for this instance that throws {@link UncheckedIOException} instead of
+ * Constructs a {@link Spliterator} for this instance that throws {@link UncheckedIOException} instead of
* {@link IOException}.
*
* @return an {@link UncheckedIOException} {@link Spliterator}.
diff --git a/src/main/java/org/apache/commons/io/function/Uncheck.java b/src/main/java/org/apache/commons/io/function/Uncheck.java
index 3b9c7d36..a593b56a 100644
--- a/src/main/java/org/apache/commons/io/function/Uncheck.java
+++ b/src/main/java/org/apache/commons/io/function/Uncheck.java
@@ -330,7 +330,7 @@ public final class Uncheck {
}
/**
- * Creates a new UncheckedIOException for the given exception.
+ * Constructs a new UncheckedIOException for the given exception.
*
* @param e The exception to wrap.
* @return a new {@link UncheckedIOException}.
@@ -340,7 +340,7 @@ public final class Uncheck {
}
/**
- * Creates a new UncheckedIOException for the given exception and detail message.
+ * Constructs a new UncheckedIOException for the given exception and detail message.
*
* @param e The exception to wrap.
* @param message The UncheckedIOException message if an I/O error occurs.
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 187e59b9..7a6089d0 100644
--- a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
@@ -91,7 +91,7 @@ public class AutoCloseInputStream extends ProxyInputStream {
}
/**
- * Creates an automatically closing proxy for the given input stream.
+ * Constructs an automatically closing proxy for the given input stream.
*
* @param in underlying input stream
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
diff --git a/src/main/java/org/apache/commons/io/input/BrokenInputStream.java b/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
index 4d846259..5eabb977 100644
--- a/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BrokenInputStream.java
@@ -43,14 +43,14 @@ public class BrokenInputStream extends InputStream {
private final Supplier<IOException> exceptionSupplier;
/**
- * Creates a new stream that always throws an {@link IOException}.
+ * Constructs a new stream that always throws an {@link IOException}.
*/
public BrokenInputStream() {
this(() -> new IOException("Broken input stream"));
}
/**
- * Creates a new stream that always throws the given exception.
+ * Constructs a new stream that always throws the given exception.
*
* @param exception the exception to be thrown.
*/
@@ -59,7 +59,7 @@ public class BrokenInputStream extends InputStream {
}
/**
- * Creates a new stream that always throws an {@link IOException}.
+ * Constructs a new stream that always throws an {@link IOException}.
*
* @param exceptionSupplier a supplier for the exception to be thrown.
* @since 2.12.0
diff --git a/src/main/java/org/apache/commons/io/input/BrokenReader.java b/src/main/java/org/apache/commons/io/input/BrokenReader.java
index 9748933f..03530e8c 100644
--- a/src/main/java/org/apache/commons/io/input/BrokenReader.java
+++ b/src/main/java/org/apache/commons/io/input/BrokenReader.java
@@ -43,14 +43,14 @@ public class BrokenReader extends Reader {
private final Supplier<IOException> exceptionSupplier;
/**
- * Creates a new reader that always throws an {@link IOException}.
+ * Constructs a new reader that always throws an {@link IOException}.
*/
public BrokenReader() {
this(() -> new IOException("Broken reader"));
}
/**
- * Creates a new reader that always throws the given exception.
+ * Constructs a new reader that always throws the given exception.
*
* @param exception the exception to be thrown.
*/
@@ -59,7 +59,7 @@ public class BrokenReader extends Reader {
}
/**
- * Creates a new reader that always throws an {@link IOException}
+ * Constructs a new reader that always throws an {@link IOException}
*
* @param exceptionSupplier a supplier for the exception to be thrown.
* @since 2.12.0
diff --git a/src/main/java/org/apache/commons/io/input/CircularInputStream.java b/src/main/java/org/apache/commons/io/input/CircularInputStream.java
index d7e04a40..26d1c3f9 100644
--- a/src/main/java/org/apache/commons/io/input/CircularInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CircularInputStream.java
@@ -56,7 +56,7 @@ public class CircularInputStream extends InputStream {
private final long targetByteCount;
/**
- * Creates an instance from the specified array of bytes.
+ * Constructs an instance from the specified array of bytes.
*
* @param repeatContent Input buffer to be repeated this buffer is not copied.
* @param targetByteCount How many bytes the read. A negative number means an infinite target count.
diff --git a/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java b/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
index 0fd10d53..03521d90 100644
--- a/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
@@ -31,7 +31,7 @@ import java.io.InputStream;
public class CloseShieldInputStream extends ProxyInputStream {
/**
- * Creates a proxy that shields the given input stream from being closed.
+ * Constructs a proxy that shields the given input stream from being closed.
*
* @param inputStream the input stream to wrap
* @return the created proxy
@@ -42,7 +42,7 @@ public class CloseShieldInputStream extends ProxyInputStream {
}
/**
- * Creates a proxy that shields the given input stream from being closed.
+ * Constructs a proxy that shields the given input stream from being closed.
*
* @param inputStream underlying input stream
* @deprecated Using this constructor prevents IDEs from warning if the
diff --git a/src/main/java/org/apache/commons/io/input/CloseShieldReader.java b/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
index 375ae20d..585a297b 100644
--- a/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
+++ b/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
@@ -31,7 +31,7 @@ import java.io.Reader;
public class CloseShieldReader extends ProxyReader {
/**
- * Creates a proxy that shields the given reader from being closed.
+ * Constructs a proxy that shields the given reader from being closed.
*
* @param reader the reader to wrap
* @return the created proxy
@@ -42,7 +42,7 @@ public class CloseShieldReader extends ProxyReader {
}
/**
- * Creates a proxy that shields the given reader from being closed.
+ * Constructs a proxy that shields the given reader from being closed.
*
* @param reader underlying reader
* @deprecated Using this constructor prevents IDEs from warning if the
diff --git a/src/main/java/org/apache/commons/io/input/InfiniteCircularInputStream.java b/src/main/java/org/apache/commons/io/input/InfiniteCircularInputStream.java
index 0514c7e4..630177e8 100644
--- a/src/main/java/org/apache/commons/io/input/InfiniteCircularInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/InfiniteCircularInputStream.java
@@ -32,7 +32,7 @@ import java.io.InputStream;
public class InfiniteCircularInputStream extends CircularInputStream {
/**
- * Creates an instance from the specified array of bytes.
+ * Constructs an instance from the specified array of bytes.
*
* @param repeatContent Input buffer to be repeated this buffer is not copied.
*/
diff --git a/src/main/java/org/apache/commons/io/input/MarkShieldInputStream.java b/src/main/java/org/apache/commons/io/input/MarkShieldInputStream.java
index 083525b7..97653fc1 100644
--- a/src/main/java/org/apache/commons/io/input/MarkShieldInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MarkShieldInputStream.java
@@ -36,7 +36,7 @@ import java.io.InputStream;
public class MarkShieldInputStream extends ProxyInputStream {
/**
- * Creates a proxy that shields the given input stream from being
+ * Constructs a proxy that shields the given input stream from being
* marked or rest.
*
* @param in underlying input stream
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 96198aaa..7aed4185 100644
--- a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
@@ -120,7 +120,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream {
private final MessageDigest messageDigest;
/**
- * Creates an MessageDigestMaintainingObserver for the given MessageDigest.
+ * Constructs an MessageDigestMaintainingObserver for the given MessageDigest.
*
* @param messageDigest the message digest to use
*/
@@ -171,7 +171,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream {
private final MessageDigest messageDigest;
/**
- * Creates a new instance, which calculates a signature on the given stream, using a {@link MessageDigest} with the "MD5" algorithm.
+ * Constructs a new instance, which calculates a signature on the given stream, using a {@link MessageDigest} with the "MD5" algorithm.
* <p>
* The MD5 algorithm is weak and should not be used.
* </p>
@@ -186,7 +186,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream {
}
/**
- * Creates a new instance, which calculates a signature on the given stream, using the given {@link MessageDigest}.
+ * Constructs 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
@@ -199,7 +199,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream {
}
/**
- * Creates a new instance, which calculates a signature on the given stream, using a {@link MessageDigest} with the given algorithm.
+ * Constructs a new instance, which calculates a signature on the given stream, using a {@link MessageDigest} with the given algorithm.
*
* @param inputStream the stream to calculate the message digest for
* @param algorithm the name of the algorithm requested. See the MessageDigest section in the
diff --git a/src/main/java/org/apache/commons/io/input/NullReader.java b/src/main/java/org/apache/commons/io/input/NullReader.java
index 194d16fd..ba221e04 100644
--- a/src/main/java/org/apache/commons/io/input/NullReader.java
+++ b/src/main/java/org/apache/commons/io/input/NullReader.java
@@ -82,7 +82,7 @@ public class NullReader extends Reader {
private final boolean markSupported;
/**
- * Creates a {@link Reader} that emulates a size 0 reader
+ * Constructs a {@link Reader} that emulates a size 0 reader
* which supports marking and does not throw EOFException.
*
* @since 2.7
@@ -92,7 +92,7 @@ public class NullReader extends Reader {
}
/**
- * Creates a {@link Reader} that emulates a specified size
+ * Constructs a {@link Reader} that emulates a specified size
* which supports marking and does not throw EOFException.
*
* @param size The size of the reader to emulate.
@@ -102,7 +102,7 @@ public class NullReader extends Reader {
}
/**
- * Creates a {@link Reader} that emulates a specified
+ * Constructs a {@link Reader} that emulates a specified
* size with option settings.
*
* @param size The size of the reader to emulate.
diff --git a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
index 259f64c9..ee080f06 100644
--- a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
@@ -110,7 +110,7 @@ public class ObservableInputStream extends ProxyInputStream {
private final List<Observer> observers;
/**
- * Creates a new ObservableInputStream for the given InputStream.
+ * Constructs a new ObservableInputStream for the given InputStream.
*
* @param inputStream the input stream to observe.
*/
@@ -119,7 +119,7 @@ public class ObservableInputStream extends ProxyInputStream {
}
/**
- * Creates a new ObservableInputStream for the given InputStream.
+ * Constructs a new ObservableInputStream for the given InputStream.
*
* @param inputStream the input stream to observe.
* @param observers List of observer callbacks.
@@ -130,7 +130,7 @@ public class ObservableInputStream extends ProxyInputStream {
}
/**
- * Creates a new ObservableInputStream for the given InputStream.
+ * Constructs a new ObservableInputStream for the given InputStream.
*
* @param inputStream the input stream to observe.
* @param observers List of observer callbacks.
diff --git a/src/main/java/org/apache/commons/io/input/QueueInputStream.java b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
index 5956fcf9..5669a3d6 100644
--- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
@@ -183,7 +183,7 @@ public class QueueInputStream extends InputStream {
}
/**
- * Creates a new QueueOutputStream instance connected to this. Writes to the output stream will be visible to this input stream.
+ * Constructs a new QueueOutputStream instance connected to this. Writes to the output stream will be visible to this input stream.
*
* @return QueueOutputStream connected to this stream.
*/
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 02b79a03..dc4fc08d 100644
--- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
@@ -113,7 +113,7 @@ public class ReadAheadInputStream extends FilterInputStream {
}
/**
- * Creates a new daemon thread.
+ * Constructs a new daemon thread.
*
* @param r the thread's runnable.
* @return a new daemon thread.
@@ -125,7 +125,7 @@ public class ReadAheadInputStream extends FilterInputStream {
}
/**
- * Creates a new daemon executor service.
+ * Constructs a new daemon executor service.
*
* @return a new daemon executor service.
*/
@@ -178,7 +178,7 @@ public class ReadAheadInputStream extends FilterInputStream {
private final Condition asyncReadComplete = stateChangeLock.newCondition();
/**
- * Creates an instance with the specified buffer size and read-ahead threshold
+ * Constructs an instance with the specified buffer size and read-ahead threshold
*
* @param inputStream The underlying input stream.
* @param bufferSizeInBytes The buffer size.
@@ -190,7 +190,7 @@ public class ReadAheadInputStream extends FilterInputStream {
}
/**
- * Creates an instance with the specified buffer size and read-ahead threshold
+ * Constructs an instance with the specified buffer size and read-ahead threshold
*
* @param inputStream The underlying input stream.
* @param bufferSizeInBytes The buffer size.
@@ -203,7 +203,7 @@ public class ReadAheadInputStream extends FilterInputStream {
}
/**
- * Creates an instance with the specified buffer size and read-ahead threshold
+ * Constructs an instance with the specified buffer size and read-ahead threshold
*
* @param inputStream The underlying input stream.
* @param bufferSizeInBytes The buffer size.
diff --git a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
index 457573af..04c9cf91 100644
--- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
+++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
@@ -132,7 +132,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates the buffer containing any leftover bytes.
+ * Constructs the buffer containing any leftover bytes.
*/
private void createLeftOver() {
final int lineLengthBytes = currentLastBytePos + 1;
@@ -275,7 +275,7 @@ public class ReversedLinesFileReader implements Closeable {
private boolean trailingNewlineOfFileSkipped;
/**
- * Creates a ReversedLinesFileReader with default block size of 4KB and the
+ * Constructs a ReversedLinesFileReader with default block size of 4KB and the
* platform's default encoding.
*
* @param file the file to be read
@@ -288,7 +288,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates a ReversedLinesFileReader with default block size of 4KB and the
+ * Constructs a ReversedLinesFileReader with default block size of 4KB and the
* specified encoding.
*
* @param file the file to be read
@@ -303,7 +303,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates a ReversedLinesFileReader with the given block size and encoding.
+ * Constructs a ReversedLinesFileReader with the given block size and encoding.
*
* @param file the file to be read
* @param blockSize size of the internal buffer (for ideal performance this
@@ -320,7 +320,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates a ReversedLinesFileReader with the given block size and encoding.
+ * Constructs a ReversedLinesFileReader with the given block size and encoding.
*
* @param file the file to be read
* @param blockSize size of the internal buffer (for ideal performance this
@@ -341,7 +341,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates a ReversedLinesFileReader with default block size of 4KB and the
+ * Constructs a ReversedLinesFileReader with default block size of 4KB and the
* specified encoding.
*
* @param file the file to be read
@@ -356,7 +356,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates a ReversedLinesFileReader with the given block size and encoding.
+ * Constructs a ReversedLinesFileReader with the given block size and encoding.
*
* @param file the file to be read
* @param blockSize size of the internal buffer (for ideal performance this
@@ -425,7 +425,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates a ReversedLinesFileReader with the given block size and encoding.
+ * Constructs a ReversedLinesFileReader with the given block size and encoding.
*
* @param file the file to be read
* @param blockSize size of the internal buffer (for ideal performance this
diff --git a/src/main/java/org/apache/commons/io/input/TaggedInputStream.java b/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
index 6134046e..b42d44c2 100644
--- a/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/TaggedInputStream.java
@@ -74,7 +74,7 @@ public class TaggedInputStream extends ProxyInputStream {
private final Serializable tag = UUID.randomUUID();
/**
- * Creates a tagging decorator for the given input stream.
+ * Constructs a tagging decorator for the given input stream.
*
* @param proxy input stream to be decorated
*/
diff --git a/src/main/java/org/apache/commons/io/input/TaggedReader.java b/src/main/java/org/apache/commons/io/input/TaggedReader.java
index 8d74b60e..dc0d57fa 100644
--- a/src/main/java/org/apache/commons/io/input/TaggedReader.java
+++ b/src/main/java/org/apache/commons/io/input/TaggedReader.java
@@ -73,7 +73,7 @@ public class TaggedReader extends ProxyReader {
private final Serializable tag = UUID.randomUUID();
/**
- * Creates a tagging decorator for the given reader.
+ * Constructs a tagging decorator for the given reader.
*
* @param proxy reader to be decorated
*/
diff --git a/src/main/java/org/apache/commons/io/input/TeeInputStream.java b/src/main/java/org/apache/commons/io/input/TeeInputStream.java
index ae1abffb..806dec72 100644
--- a/src/main/java/org/apache/commons/io/input/TeeInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/TeeInputStream.java
@@ -51,7 +51,7 @@ public class TeeInputStream extends ProxyInputStream {
private final boolean closeBranch;
/**
- * Creates a TeeInputStream that proxies the given {@link InputStream}
+ * Constructs a TeeInputStream that proxies the given {@link InputStream}
* and copies all read bytes to the given {@link OutputStream}. The given
* output stream will not be closed when this stream gets closed.
*
@@ -63,7 +63,7 @@ public class TeeInputStream extends ProxyInputStream {
}
/**
- * Creates a TeeInputStream that proxies the given {@link InputStream}
+ * Constructs a TeeInputStream that proxies the given {@link InputStream}
* and copies all read bytes to the given {@link OutputStream}. The given
* output stream will be closed when this stream gets closed if the
* closeBranch parameter is {@code true}.
diff --git a/src/main/java/org/apache/commons/io/input/TeeReader.java b/src/main/java/org/apache/commons/io/input/TeeReader.java
index 354cac9f..d857f7b8 100644
--- a/src/main/java/org/apache/commons/io/input/TeeReader.java
+++ b/src/main/java/org/apache/commons/io/input/TeeReader.java
@@ -47,7 +47,7 @@ public class TeeReader extends ProxyReader {
private final boolean closeBranch;
/**
- * Creates a TeeReader that proxies the given {@link Reader} and copies all read characters to the given
+ * Constructs a TeeReader that proxies the given {@link Reader} and copies all read characters to the given
* {@link Writer}. The given writer will not be closed when this reader gets closed.
*
* @param input reader to be proxied
@@ -58,7 +58,7 @@ public class TeeReader extends ProxyReader {
}
/**
- * Creates a TeeReader that proxies the given {@link Reader} and copies all read characters to the given
+ * Constructs a TeeReader that proxies the given {@link Reader} and copies all read characters to the given
* {@link Writer}. The given writer will be closed when this reader gets closed if the closeBranch parameter is
* {@code true}.
*
diff --git a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
index 1a49c9bb..c0cd7c5a 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
@@ -99,7 +99,7 @@ public final class UncheckedBufferedReader extends BufferedReader {
}
/**
- * Creates a buffering character-input stream that uses an input buffer of the specified size.
+ * Constructs a buffering character-input stream that uses an input buffer of the specified size.
*
* @param reader A Reader
* @param bufferSize Input-buffer size
diff --git a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
index 58609c10..d1b00c2b 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
@@ -92,7 +92,7 @@ public final class UncheckedFilterInputStream extends FilterInputStream {
}
/**
- * Creates a {@link UncheckedFilterInputStream}.
+ * Constructs a {@link UncheckedFilterInputStream}.
*
* @param inputStream the underlying input stream, or {@code null} if this instance is to be created without an
* underlying stream.
diff --git a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java
index 768a16b7..4b9fe8e1 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java
@@ -95,7 +95,7 @@ public final class UncheckedFilterReader extends FilterReader {
}
/**
- * Creates a new filtered reader.
+ * Constructs a new filtered reader.
*
* @param reader a Reader object providing the underlying stream.
* @throws NullPointerException if {@code reader} is {@code null}.
diff --git a/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java b/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
index 175776f5..7b0ebb22 100644
--- a/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
@@ -41,7 +41,7 @@ public class UnixLineEndingInputStream extends InputStream {
private final boolean lineFeedAtEndOfFile;
/**
- * Creates an input stream that filters another stream
+ * Constructs an input stream that filters another stream
*
* @param inputStream The input stream to wrap
* @param ensureLineFeedAtEndOfFile true to ensure that the file ends with LF
diff --git a/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java b/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
index 9799e99e..f8507523 100644
--- a/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
+++ b/src/main/java/org/apache/commons/io/input/UnsupportedOperationExceptions.java
@@ -29,7 +29,7 @@ class UnsupportedOperationExceptions {
private static final String MARK_RESET = "mark/reset";
/**
- * Creates a new instance of UnsupportedOperationException for a {@code mark} method.
+ * Constructs a new instance of UnsupportedOperationException for a {@code mark} method.
*
* @return a new instance of UnsupportedOperationException
*/
@@ -39,7 +39,7 @@ class UnsupportedOperationExceptions {
}
/**
- * Creates a new instance of UnsupportedOperationException for the given unsupported a {@code method} name.
+ * Constructs a new instance of UnsupportedOperationException for the given unsupported a {@code method} name.
*
* @param method A method name
* @return a new instance of UnsupportedOperationException
@@ -49,7 +49,7 @@ class UnsupportedOperationExceptions {
}
/**
- * Creates a new instance of UnsupportedOperationException for a {@code reset} method.
+ * Constructs a new instance of UnsupportedOperationException for a {@code reset} method.
*
* @return a new instance of UnsupportedOperationException
*/
diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java
index a3f489b2..a4fc696c 100644
--- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java
@@ -161,7 +161,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream {
private int markedOffset;
/**
- * Creates a new byte array input stream.
+ * Constructs a new byte array input stream.
*
* @param data the buffer
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
@@ -175,7 +175,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream {
}
/**
- * Creates a new byte array input stream.
+ * Constructs a new byte array input stream.
*
* @param data the buffer
* @param offset the offset into the buffer
@@ -196,7 +196,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream {
}
/**
- * Creates a new byte array input stream.
+ * Constructs a new byte array input stream.
*
* @param data the buffer
* @param offset the offset into the buffer
diff --git a/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java b/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
index ee908e1d..e5ba818d 100644
--- a/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
@@ -43,7 +43,7 @@ public class WindowsLineEndingInputStream extends InputStream {
private final boolean lineFeedAtEndOfFile;
/**
- * Creates an input stream that filters another stream
+ * Constructs an input stream that filters another stream
*
* @param in The input stream to wrap
* @param ensureLineFeedAtEndOfFile true to ensure that the file ends with CRLF
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java b/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
index 75703298..1402a748 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
@@ -46,7 +46,7 @@ public class XmlStreamReaderException extends IOException {
private final String contentTypeEncoding;
/**
- * Creates an exception instance if the charset encoding could not be
+ * Constructs an exception instance if the charset encoding could not be
* determined.
* <p>
* Instances of this exception are thrown by the XmlStreamReader.
@@ -63,7 +63,7 @@ public class XmlStreamReaderException extends IOException {
}
/**
- * Creates an exception instance if the charset encoding could not be
+ * Constructs an exception instance if the charset encoding could not be
* determined.
* <p>
* Instances of this exception are thrown by the XmlStreamReader.
diff --git a/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java b/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java
index 3ac9ae12..2432cd54 100644
--- a/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java
@@ -41,7 +41,7 @@ public class CircularBufferInputStream extends FilterInputStream {
private boolean eof;
/**
- * Creates a new instance, which filters the given input stream, and uses a reasonable default buffer size
+ * Constructs a new instance, which filters the given input stream, and uses a reasonable default buffer size
* ({@link IOUtils#DEFAULT_BUFFER_SIZE}).
*
* @param inputStream The input stream, which is being buffered.
@@ -51,7 +51,7 @@ public class CircularBufferInputStream extends FilterInputStream {
}
/**
- * Creates a new instance, which filters the given input stream, and uses the given buffer size.
+ * Constructs a new instance, which filters the given input stream, and uses the given buffer size.
*
* @param inputStream The input stream, which is being buffered.
* @param bufferSize The size of the {@link CircularByteBuffer}, which is used internally.
diff --git a/src/main/java/org/apache/commons/io/input/buffer/CircularByteBuffer.java b/src/main/java/org/apache/commons/io/input/buffer/CircularByteBuffer.java
index b65992a3..f8e6dd3d 100644
--- a/src/main/java/org/apache/commons/io/input/buffer/CircularByteBuffer.java
+++ b/src/main/java/org/apache/commons/io/input/buffer/CircularByteBuffer.java
@@ -34,14 +34,14 @@ public class CircularByteBuffer {
private int currentNumberOfBytes;
/**
- * Creates a new instance with a reasonable default buffer size ({@link IOUtils#DEFAULT_BUFFER_SIZE}).
+ * Constructs a new instance with a reasonable default buffer size ({@link IOUtils#DEFAULT_BUFFER_SIZE}).
*/
public CircularByteBuffer() {
this(IOUtils.DEFAULT_BUFFER_SIZE);
}
/**
- * Creates a new instance with the given buffer size.
+ * Constructs a new instance with the given buffer size.
*
* @param size the size of buffer to create
*/
diff --git a/src/main/java/org/apache/commons/io/input/buffer/PeekableInputStream.java b/src/main/java/org/apache/commons/io/input/buffer/PeekableInputStream.java
index a2c55f81..086ac9d2 100644
--- a/src/main/java/org/apache/commons/io/input/buffer/PeekableInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/buffer/PeekableInputStream.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.IOUtils;
public class PeekableInputStream extends CircularBufferInputStream {
/**
- * Creates a new instance, which filters the given input stream, and uses a reasonable default buffer size ({@link IOUtils#DEFAULT_BUFFER_SIZE}).
+ * Constructs a new instance, which filters the given input stream, and uses a reasonable default buffer size ({@link IOUtils#DEFAULT_BUFFER_SIZE}).
*
* @param inputStream The input stream, which is being buffered.
*/
@@ -38,7 +38,7 @@ public class PeekableInputStream extends CircularBufferInputStream {
}
/**
- * Creates a new instance, which filters the given input stream, and uses the given buffer size.
+ * Constructs a new instance, which filters the given input stream, and uses the given buffer size.
*
* @param inputStream The input stream, which is being buffered.
* @param bufferSize The size of the {@link CircularByteBuffer}, which is used internally.
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 63964e95..837f2df5 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileEntry.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileEntry.java
@@ -183,7 +183,7 @@ public class FileEntry implements Serializable {
}
/**
- * Creates a new child instance.
+ * Constructs a new child instance.
* <p>
* Custom implementations should override this method to return
* a new instance of the appropriate type.
diff --git a/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java b/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java
index 59d655a4..4accc56d 100644
--- a/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java
@@ -45,14 +45,14 @@ public class BrokenOutputStream extends OutputStream {
private final Supplier<IOException> exceptionSupplier;
/**
- * Creates a new stream that always throws an {@link IOException}.
+ * Constructs a new stream that always throws an {@link IOException}.
*/
public BrokenOutputStream() {
this(() -> new IOException("Broken output stream"));
}
/**
- * Creates a new stream that always throws the given exception.
+ * Constructs a new stream that always throws the given exception.
*
* @param exception the exception to be thrown.
*/
@@ -61,7 +61,7 @@ public class BrokenOutputStream extends OutputStream {
}
/**
- * Creates a new stream that always throws an {@link IOException}.
+ * Constructs a new stream that always throws an {@link IOException}.
*
* @param exceptionSupplier a supplier for the exception to be thrown.
* @since 2.12.0
diff --git a/src/main/java/org/apache/commons/io/output/BrokenWriter.java b/src/main/java/org/apache/commons/io/output/BrokenWriter.java
index 9755a537..c56d9a31 100644
--- a/src/main/java/org/apache/commons/io/output/BrokenWriter.java
+++ b/src/main/java/org/apache/commons/io/output/BrokenWriter.java
@@ -43,14 +43,14 @@ public class BrokenWriter extends Writer {
private final Supplier<IOException> exceptionSupplier;
/**
- * Creates a new writer that always throws an {@link IOException}.
+ * Constructs a new writer that always throws an {@link IOException}.
*/
public BrokenWriter() {
this(() -> new IOException("Broken writer"));
}
/**
- * Creates a new writer that always throws the given exception.
+ * Constructs a new writer that always throws the given exception.
*
* @param exception the exception to be thrown.
*/
@@ -59,7 +59,7 @@ public class BrokenWriter extends Writer {
}
/**
- * Creates a new writer that always throws an {@link IOException}.
+ * Constructs a new writer that always throws an {@link IOException}.
*
* @param exceptionSupplier a supplier for the exception to be thrown.
* @since 2.12.0
diff --git a/src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java
index 23474f9f..b2b310ab 100644
--- a/src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java
@@ -86,7 +86,7 @@ public class ByteArrayOutputStream extends AbstractByteArrayOutputStream {
}
/**
- * Creates a new byte array output stream. The buffer capacity is
+ * Constructs a new byte array output stream. The buffer capacity is
* initially {@value AbstractByteArrayOutputStream#DEFAULT_SIZE} bytes, though its size increases if necessary.
*/
public ByteArrayOutputStream() {
@@ -94,7 +94,7 @@ public class ByteArrayOutputStream extends AbstractByteArrayOutputStream {
}
/**
- * Creates a new byte array output stream, with a buffer capacity of
+ * Constructs a new byte array output stream, with a buffer capacity of
* the specified size, in bytes.
*
* @param size the initial size
diff --git a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
index 396fd360..854939f0 100644
--- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
@@ -94,7 +94,7 @@ public class ChunkedOutputStream extends FilterOutputStream {
private final int chunkSize;
/**
- * Creates a new stream that uses a chunk size of {@link IOUtils#DEFAULT_BUFFER_SIZE}.
+ * Constructs a new stream that uses a chunk size of {@link IOUtils#DEFAULT_BUFFER_SIZE}.
*
* @param stream the stream to wrap
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
@@ -105,7 +105,7 @@ public class ChunkedOutputStream extends FilterOutputStream {
}
/**
- * Creates a new stream that uses the specified chunk size.
+ * Constructs a new stream that uses the specified chunk size.
*
* @param stream the stream to wrap
* @param chunkSize the chunk size to use; must be a positive number.
diff --git a/src/main/java/org/apache/commons/io/output/ChunkedWriter.java b/src/main/java/org/apache/commons/io/output/ChunkedWriter.java
index 37930ac1..417f19e6 100644
--- a/src/main/java/org/apache/commons/io/output/ChunkedWriter.java
+++ b/src/main/java/org/apache/commons/io/output/ChunkedWriter.java
@@ -42,7 +42,7 @@ public class ChunkedWriter extends FilterWriter {
private final int chunkSize;
/**
- * Creates a new writer that uses a chunk size of {@link #DEFAULT_CHUNK_SIZE}
+ * Constructs a new writer that uses a chunk size of {@link #DEFAULT_CHUNK_SIZE}
* @param writer the writer to wrap
*/
public ChunkedWriter(final Writer writer) {
@@ -50,7 +50,7 @@ public class ChunkedWriter extends FilterWriter {
}
/**
- * Creates a new writer that uses the specified chunk size.
+ * Constructs a new writer that uses the specified chunk size.
*
* @param writer the writer to wrap
* @param chunkSize the chunk size to use; must be a positive number.
@@ -65,7 +65,8 @@ public class ChunkedWriter extends FilterWriter {
}
/**
- * writes the data buffer in chunks to the underlying writer
+ * Writes the data buffer in chunks to the underlying writer.
+ *
* @param data The data
* @param srcOffset the offset
* @param length the number of bytes to write
diff --git a/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java b/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java
index a5c5485d..28ff2897 100644
--- a/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java
@@ -31,7 +31,7 @@ import java.io.OutputStream;
public class CloseShieldOutputStream extends ProxyOutputStream {
/**
- * Creates a proxy that shields the given output stream from being closed.
+ * Constructs a proxy that shields the given output stream from being closed.
*
* @param outputStream the output stream to wrap
* @return the created proxy
@@ -42,7 +42,7 @@ public class CloseShieldOutputStream extends ProxyOutputStream {
}
/**
- * Creates a proxy that shields the given output stream from being closed.
+ * Constructs a proxy that shields the given output stream from being closed.
*
* @param outputStream underlying output stream
* @deprecated Using this constructor prevents IDEs from warning if the
diff --git a/src/main/java/org/apache/commons/io/output/CloseShieldWriter.java b/src/main/java/org/apache/commons/io/output/CloseShieldWriter.java
index 8d741acf..f481b752 100644
--- a/src/main/java/org/apache/commons/io/output/CloseShieldWriter.java
+++ b/src/main/java/org/apache/commons/io/output/CloseShieldWriter.java
@@ -31,7 +31,7 @@ import java.io.Writer;
public class CloseShieldWriter extends ProxyWriter {
/**
- * Creates a proxy that shields the given writer from being closed.
+ * Constructs a proxy that shields the given writer from being closed.
*
* @param writer the writer to wrap
* @return the created proxy
@@ -42,7 +42,7 @@ public class CloseShieldWriter extends ProxyWriter {
}
/**
- * Creates a proxy that shields the given writer from being closed.
+ * Constructs a proxy that shields the given writer from being closed.
*
* @param writer underlying writer
* @deprecated Using this constructor prevents IDEs from warning if the
diff --git a/src/main/java/org/apache/commons/io/output/CountingOutputStream.java b/src/main/java/org/apache/commons/io/output/CountingOutputStream.java
index c73acb60..5be3721e 100644
--- a/src/main/java/org/apache/commons/io/output/CountingOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/CountingOutputStream.java
@@ -58,6 +58,7 @@ public class CountingOutputStream extends ProxyOutputStream {
* NOTE: This method is an alternative for {@code getCount()}.
* It was added because that method returns an integer which will
* result in incorrect count for files over 2GB.
+ * </p>
*
* @return the number of bytes accumulated
* @since 1.3
@@ -67,11 +68,12 @@ public class CountingOutputStream extends ProxyOutputStream {
}
/**
- * The number of bytes that have passed through this stream.
+ * Gets the number of bytes that have passed through this stream.
* <p>
* 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}.
+ * </p>
*
* @return the number of bytes accumulated
* @throws ArithmeticException if the byte count is too large
@@ -90,6 +92,7 @@ public class CountingOutputStream extends ProxyOutputStream {
* NOTE: This method is an alternative for {@code resetCount()}.
* It was added because that method returns an integer which will
* result in incorrect count for files over 2GB.
+ * </p>
*
* @return the count previous to resetting
* @since 1.3
@@ -106,6 +109,7 @@ public class CountingOutputStream extends ProxyOutputStream {
* 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}.
+ * </p>
*
* @return the count previous to resetting
* @throws ArithmeticException if the byte count is too large
diff --git a/src/main/java/org/apache/commons/io/output/FilterCollectionWriter.java b/src/main/java/org/apache/commons/io/output/FilterCollectionWriter.java
index f6c0aa8e..d8ce429d 100644
--- a/src/main/java/org/apache/commons/io/output/FilterCollectionWriter.java
+++ b/src/main/java/org/apache/commons/io/output/FilterCollectionWriter.java
@@ -57,7 +57,7 @@ public class FilterCollectionWriter extends Writer {
protected final Collection<Writer> writers;
/**
- * Creates a new filtered collection writer.
+ * Constructs a new filtered collection writer.
*
* @param writers Writers to provide the underlying targets.
*/
@@ -66,7 +66,7 @@ public class FilterCollectionWriter extends Writer {
}
/**
- * Creates a new filtered collection writer.
+ * Constructs a new filtered collection writer.
*
* @param writers Writers to provide the underlying targets.
*/
diff --git a/src/main/java/org/apache/commons/io/output/ProxyCollectionWriter.java b/src/main/java/org/apache/commons/io/output/ProxyCollectionWriter.java
index 0a4c0378..008feb57 100644
--- a/src/main/java/org/apache/commons/io/output/ProxyCollectionWriter.java
+++ b/src/main/java/org/apache/commons/io/output/ProxyCollectionWriter.java
@@ -36,7 +36,7 @@ import org.apache.commons.io.IOUtils;
public class ProxyCollectionWriter extends FilterCollectionWriter {
/**
- * Creates a new proxy collection writer.
+ * Constructs a new proxy collection writer.
*
* @param writers Writers object to provide the underlying targets.
*/
@@ -45,7 +45,7 @@ public class ProxyCollectionWriter extends FilterCollectionWriter {
}
/**
- * Creates a new proxy collection writer.
+ * Constructs a new proxy collection writer.
*
* @param writers Writers to provide the underlying targets.
*/
diff --git a/src/main/java/org/apache/commons/io/output/QueueOutputStream.java b/src/main/java/org/apache/commons/io/output/QueueOutputStream.java
index 4281aec3..dc2319b9 100644
--- a/src/main/java/org/apache/commons/io/output/QueueOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/QueueOutputStream.java
@@ -74,7 +74,7 @@ public class QueueOutputStream extends OutputStream {
}
/**
- * Creates a new QueueInputStream instance connected to this. Writes to this output stream will be visible to the
+ * Constructs a new QueueInputStream instance connected to this. Writes to this output stream will be visible to the
* input stream.
*
* @return QueueInputStream connected to this stream
diff --git a/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java b/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java
index eeb23a0c..72d0ec97 100644
--- a/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java
@@ -70,7 +70,7 @@ public class TaggedOutputStream extends ProxyOutputStream {
private final Serializable tag = UUID.randomUUID();
/**
- * Creates a tagging decorator for the given output stream.
+ * Constructs a tagging decorator for the given output stream.
*
* @param proxy output stream to be decorated
*/
diff --git a/src/main/java/org/apache/commons/io/output/TaggedWriter.java b/src/main/java/org/apache/commons/io/output/TaggedWriter.java
index eb6f79df..828d9ae3 100644
--- a/src/main/java/org/apache/commons/io/output/TaggedWriter.java
+++ b/src/main/java/org/apache/commons/io/output/TaggedWriter.java
@@ -70,7 +70,7 @@ public class TaggedWriter extends ProxyWriter {
private final Serializable tag = UUID.randomUUID();
/**
- * Creates a tagging decorator for the given writer.
+ * Constructs a tagging decorator for the given writer.
*
* @param proxy writer to be decorated
*/
diff --git a/src/main/java/org/apache/commons/io/output/TeeWriter.java b/src/main/java/org/apache/commons/io/output/TeeWriter.java
index e373bc1d..2db4e6af 100644
--- a/src/main/java/org/apache/commons/io/output/TeeWriter.java
+++ b/src/main/java/org/apache/commons/io/output/TeeWriter.java
@@ -32,7 +32,7 @@ import java.util.Collection;
public class TeeWriter extends ProxyCollectionWriter {
/**
- * Creates a new filtered collection writer.
+ * Constructs a new filtered collection writer.
*
* @param writers Writers to provide the underlying targets.
*/
@@ -41,7 +41,7 @@ public class TeeWriter extends ProxyCollectionWriter {
}
/**
- * Creates a new filtered collection writer.
+ * Constructs a new filtered collection writer.
*
* @param writers Writers to provide the underlying targets.
*/
diff --git a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
index 258d993e..1d8a3a03 100644
--- a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
@@ -135,7 +135,7 @@ public class ThresholdingOutputStream extends OutputStream {
}
/**
- * Returns the number of bytes that have been written to this output stream.
+ * Gets the number of bytes that have been written to this output stream.
*
* @return The number of bytes written.
*/
@@ -169,7 +169,7 @@ public class ThresholdingOutputStream extends OutputStream {
}
/**
- * Returns the threshold, in bytes, at which an event will be triggered.
+ * Gets the threshold, in bytes, at which an event will be triggered.
*
* @return The threshold point, in bytes.
*/
@@ -178,7 +178,7 @@ public class ThresholdingOutputStream extends OutputStream {
}
/**
- * Determines whether or not the configured threshold has been exceeded for this output stream.
+ * Tests whether or not the configured threshold has been exceeded for this output stream.
*
* @return {@code true} if the threshold has been reached; {@code false} otherwise.
*/
diff --git a/src/main/java/org/apache/commons/io/output/UncheckedAppendable.java b/src/main/java/org/apache/commons/io/output/UncheckedAppendable.java
index 8abda709..e606db4d 100644
--- a/src/main/java/org/apache/commons/io/output/UncheckedAppendable.java
+++ b/src/main/java/org/apache/commons/io/output/UncheckedAppendable.java
@@ -31,7 +31,7 @@ import java.io.UncheckedIOException;
public interface UncheckedAppendable extends Appendable {
/**
- * Creates a new instance on the given Appendable.
+ * Constructs a new instance on the given Appendable.
*
* @param appendable The Appendable to uncheck.
* @return a new instance.
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 c1e9b7ae..91f115db 100644
--- a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
@@ -91,7 +91,7 @@ public final class UncheckedFilterOutputStream extends FilterOutputStream {
}
/**
- * Creates an output stream filter built on top of the specified underlying output stream.
+ * Constructs an output stream filter built on top of the specified underlying output stream.
*
* @param outputStream the underlying output stream, or {@code null} if this instance is to be created without an
* underlying stream.
diff --git a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
index 14a98226..f152f487 100644
--- a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
+++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
@@ -91,7 +91,7 @@ public final class UncheckedFilterWriter extends FilterWriter {
}
/**
- * Creates a new filtered writer.
+ * Constructs a new filtered writer.
*
* @param writer a Writer object providing the underlying stream.
* @throws NullPointerException if {@code writer} is {@code null}.
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 15f2fb71..7b3c036b 100644
--- a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
@@ -131,7 +131,7 @@ public final class UnsynchronizedByteArrayOutputStream extends AbstractByteArray
}
/**
- * Creates a new byte array output stream. The buffer capacity is initially
+ * Constructs a new byte array output stream. The buffer capacity is initially
*
* {@value AbstractByteArrayOutputStream#DEFAULT_SIZE} bytes, though its size increases if necessary.
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
@@ -142,7 +142,7 @@ public final class UnsynchronizedByteArrayOutputStream extends AbstractByteArray
}
/**
- * Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
+ * Constructs a new byte array output stream, with a buffer capacity of the specified size, in bytes.
*
* @param size the initial size
* @throws IllegalArgumentException if size is negative
[commons-io] 03/04: Add ThresholdingOutputStream.getOutputStream() and deprecate getStream()
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit 5035e97fa05344aa3193fb2d916939e4988d38eb
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jul 9 10:23:48 2023 -0400
Add ThresholdingOutputStream.getOutputStream() and deprecate getStream()
---
src/changes/changes.xml | 3 +++
.../io/output/ThresholdingOutputStream.java | 22 ++++++++++++++++--
.../io/output/ThresholdingOutputStreamTest.java | 27 +++++++++++++++++++++-
3 files changed, 49 insertions(+), 3 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index cb73ef80..c9f9e0e3 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -98,6 +98,9 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" type="add" due-to="Gary Gregory">
Add PathMatcherFileFilter to adapt java.nio.file.PathMatcher.
</action>
+ <action dev="ggregory" type="add" due-to="Gary Gregory">
+ Add ThresholdingOutputStream.getOutputStream() and deprecate getStream().
+ </action>
<!-- UPDATE -->
<action dev="ggregory" type="update" due-to="Dependabot">
Bump jimfs from 1.2 to 1.3.0 #465 (tests).
diff --git a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
index 9153f0bc..258d993e 100644
--- a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
@@ -118,6 +118,7 @@ public class ThresholdingOutputStream extends OutputStream {
} catch (final IOException ignored) {
// ignore
}
+ // TODO for 4.0: Replace with getOutputStream()
getStream().close();
}
@@ -129,6 +130,7 @@ public class ThresholdingOutputStream extends OutputStream {
@SuppressWarnings("resource") // the underlying stream is managed by a subclass.
@Override
public void flush() throws IOException {
+ // TODO for 4.0: Replace with getOutputStream()
getStream().flush();
}
@@ -142,14 +144,27 @@ public class ThresholdingOutputStream extends OutputStream {
}
/**
- * Returns the underlying output stream, to which the corresponding {@link OutputStream} methods in this class will
+ * Gets the underlying output stream, to which the corresponding {@link OutputStream} methods in this class will
* ultimately delegate.
*
* @return The underlying output stream.
- *
* @throws IOException if an error occurs.
+ * @deprecated Use {@link #getOutputStream()}.
*/
+ @Deprecated
protected OutputStream getStream() throws IOException {
+ return getOutputStream();
+ }
+
+ /**
+ * Gets the underlying output stream, to which the corresponding {@link OutputStream} methods in this class will
+ * ultimately delegate.
+ *
+ * @return The underlying output stream.
+ * @throws IOException if an error occurs.
+ * @since 2.14.0
+ */
+ protected OutputStream getOutputStream() throws IOException {
return outputStreamGetter.apply(this);
}
@@ -212,6 +227,7 @@ public class ThresholdingOutputStream extends OutputStream {
@Override
public void write(final byte[] b) throws IOException {
checkThreshold(b.length);
+ // TODO for 4.0: Replace with getOutputStream()
getStream().write(b);
written += b.length;
}
@@ -229,6 +245,7 @@ public class ThresholdingOutputStream extends OutputStream {
@Override
public void write(final byte[] b, final int off, final int len) throws IOException {
checkThreshold(len);
+ // TODO for 4.0: Replace with getOutputStream()
getStream().write(b, off, len);
written += len;
}
@@ -244,6 +261,7 @@ public class ThresholdingOutputStream extends OutputStream {
@Override
public void write(final int b) throws IOException {
checkThreshold(1);
+ // TODO for 4.0: Replace with getOutputStream()
getStream().write(b);
written++;
}
diff --git a/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java
index b342d28c..dd1299e0 100644
--- a/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java
@@ -33,7 +33,7 @@ import org.junit.jupiter.api.Test;
public class ThresholdingOutputStreamTest {
@Test
- public void testSetByteCount() throws Exception {
+ public void testSetByteCount_Stream() throws Exception {
final AtomicBoolean reached = new AtomicBoolean(false);
try (ThresholdingOutputStream tos = new ThresholdingOutputStream(3) {
{
@@ -57,6 +57,31 @@ public class ThresholdingOutputStreamTest {
}
}
+ @Test
+ public void testSetByteCount_OutputStream() throws Exception {
+ final AtomicBoolean reached = new AtomicBoolean(false);
+ try (ThresholdingOutputStream tos = new ThresholdingOutputStream(3) {
+ {
+ setByteCount(2);
+ }
+
+ @Override
+ protected OutputStream getOutputStream() throws IOException {
+ return new ByteArrayOutputStream(4);
+ }
+
+ @Override
+ protected void thresholdReached() throws IOException {
+ reached.set(true);
+ }
+ }) {
+ tos.write('a');
+ assertFalse(reached.get());
+ tos.write('a');
+ assertTrue(reached.get());
+ }
+ }
+
@Test
public void testThresholdIOConsumer() throws Exception {
final AtomicBoolean reached = new AtomicBoolean();
[commons-io] 02/04: Test should generate temporary files in the Maven "target" folder instead of the root
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit ba967e37989bf21a3f2244f2b1b104cbb5b7b22a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jul 9 10:21:40 2023 -0400
Test should generate temporary files in the Maven "target" folder
instead of the root
---
.../org/apache/commons/io/output/DeferredFileOutputStreamTest.java | 7 ++++---
1 file changed, 4 insertions(+), 3 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 8ee317f8..3969e714 100644
--- a/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/DeferredFileOutputStreamTest.java
@@ -29,6 +29,7 @@ import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
+import java.nio.file.Paths;
import java.util.stream.IntStream;
import org.apache.commons.io.FileUtils;
@@ -195,14 +196,14 @@ public class DeferredFileOutputStreamTest {
final String prefix = "commons-io-test";
final String suffix = ".out";
- final File tempDir = FileUtils.current();
+ final Path tempDir = Paths.get("target");
// @formatter:off
final DeferredFileOutputStream dfos = DeferredFileOutputStream.builder()
.setThreshold(testBytes.length - 5)
.setBufferSize(initialBufferSize)
.setPrefix(prefix)
.setSuffix(suffix)
- .setDirectory(tempDir)
+ .setDirectory(tempDir.toFile())
.get();
// @formatter:on
assertNull(dfos.getFile(), "Check File is null-A");
@@ -216,7 +217,7 @@ public class DeferredFileOutputStreamTest {
assertTrue(dfos.getFile().exists(), "Check file exists");
assertTrue(dfos.getFile().getName().startsWith(prefix), "Check prefix");
assertTrue(dfos.getFile().getName().endsWith(suffix), "Check suffix");
- assertEquals(tempDir.getPath(), dfos.getFile().getParent(), "Check dir");
+ assertEquals(tempDir, dfos.getPath().getParent(), "Check dir");
verifyResultFile(dfos.getFile());