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 2024/12/10 21:07:43 UTC
(commons-io) branch master updated: Javadoc: Add missing constructor Javadoc comments
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 ce894b214 Javadoc: Add missing constructor Javadoc comments
ce894b214 is described below
commit ce894b21480087d5f6ceba10b992a2cf4127d726
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Dec 10 16:07:35 2024 -0500
Javadoc: Add missing constructor Javadoc comments
---
.../java/org/apache/commons/io/ByteBuffers.java | 65 +++++++++++++++++++++
.../commons/io/filefilter/WildcardFileFilter.java | 7 +++
.../commons/io/input/AbstractInputStream.java | 7 +++
.../commons/io/input/AutoCloseInputStream.java | 7 +++
.../apache/commons/io/input/BOMInputStream.java | 7 +++
.../commons/io/input/BoundedInputStream.java | 7 +++
.../io/input/BufferedFileChannelInputStream.java | 7 +++
.../commons/io/input/CharSequenceInputStream.java | 7 +++
.../commons/io/input/ChecksumInputStream.java | 7 +++
.../io/input/MemoryMappedFileInputStream.java | 2 +-
.../input/MessageDigestCalculatingInputStream.java | 2 +-
.../commons/io/input/MessageDigestInputStream.java | 2 +-
.../commons/io/input/ObservableInputStream.java | 7 +++
.../apache/commons/io/input/ProxyInputStream.java | 7 +++
.../apache/commons/io/input/QueueInputStream.java | 7 +++
.../io/input/RandomAccessFileInputStream.java | 7 +++
.../commons/io/input/ReadAheadInputStream.java | 7 +++
.../apache/commons/io/input/ReaderInputStream.java | 7 +++
.../commons/io/input/ReversedLinesFileReader.java | 66 +++++++++++-----------
.../java/org/apache/commons/io/input/Tailer.java | 7 +++
.../commons/io/input/TailerListenerAdapter.java | 7 +++
.../commons/io/input/ThrottledInputStream.java | 7 +++
.../commons/io/input/UncheckedBufferedReader.java | 7 +++
.../io/input/UncheckedFilterInputStream.java | 7 +++
.../commons/io/input/UncheckedFilterReader.java | 7 +++
.../input/UnsynchronizedBufferedInputStream.java | 7 +++
.../input/UnsynchronizedByteArrayInputStream.java | 7 +++
.../io/input/UnsynchronizedFilterInputStream.java | 7 +++
.../commons/io/input/UnsynchronizedReader.java | 7 +++
.../apache/commons/io/input/XmlStreamReader.java | 7 +++
.../commons/io/output/ChunkedOutputStream.java | 7 +++
.../io/output/DeferredFileOutputStream.java | 2 +-
.../commons/io/output/FileWriterWithEncoding.java | 7 +++
.../commons/io/output/LockableFileWriter.java | 2 +-
.../io/output/UncheckedFilterOutputStream.java | 7 +++
.../commons/io/output/UncheckedFilterWriter.java | 7 +++
.../UnsynchronizedByteArrayOutputStream.java | 7 +++
.../commons/io/output/WriterOutputStream.java | 2 +-
.../apache/commons/io/output/XmlStreamWriter.java | 2 +-
.../serialization/ValidatingObjectInputStream.java | 2 +-
40 files changed, 316 insertions(+), 41 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteBuffers.java b/src/main/java/org/apache/commons/io/ByteBuffers.java
new file mode 100644
index 000000000..8992d3256
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/ByteBuffers.java
@@ -0,0 +1,65 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.commons.io;
+
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+
+/**
+ * Manufactures {@link ByteBuffer} instances.
+ *
+ * @since 2.19.0
+ */
+public class ByteBuffers {
+
+ /**
+ * Allocates a new byte buffer with little-endian byte order. The bytes of a multibyte value are ordered from least significant to most significant.
+ * <p>
+ * The new buffer's position is zero, the limit is its capacity, the mark is undefined, and each of element is initialized to zero. The new buffer has the
+ * given backing {@code array}, and its {@link ByteBuffer#arrayOffset() array offset} is zero.
+ * </p>
+ *
+ * @param array The array that will back the new byte buffer.
+ * @return The new byte buffer.
+ */
+ public static ByteBuffer littleEndian(final byte[] array) {
+ return littleEndian(ByteBuffer.wrap(array));
+ }
+
+ public static ByteBuffer littleEndian(final ByteBuffer allocate) {
+ return allocate.order(ByteOrder.LITTLE_ENDIAN);
+ }
+
+ /**
+ * Allocates a new byte buffer with little-endian byte order. The bytes of a multibyte value are ordered from least significant to most significant.
+ * <p>
+ * The new buffer's position is zero, the limit is its capacity, the mark is undefined, and each of element is initialized to zero. The new buffer has a
+ * {@link ByteBuffer#array() backing array}, and its {@link ByteBuffer#arrayOffset() array offset} is zero.
+ * </p>
+ *
+ * @param capacity The new buffer's capacity, in bytes.
+ * @return The new byte buffer.
+ * @throws IllegalArgumentException If the <code>capacity</code> is negative.
+ */
+ public static ByteBuffer littleEndian(final int capacity) {
+ return littleEndian(ByteBuffer.allocate(capacity));
+ }
+
+}
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 6ee4db921..1e1140f6d 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
@@ -98,6 +98,13 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab
/** Whether the comparison is case-sensitive. */
private IOCase ioCase = IOCase.SENSITIVE;
+ /**
+ * Constructs a new builder of {@link WildcardFileFilter}.
+ */
+ public Builder() {
+ // empty
+ }
+
@Override
public WildcardFileFilter get() {
return new WildcardFileFilter(ioCase, wildcards);
diff --git a/src/main/java/org/apache/commons/io/input/AbstractInputStream.java b/src/main/java/org/apache/commons/io/input/AbstractInputStream.java
index 7a300a5f5..d37e14441 100644
--- a/src/main/java/org/apache/commons/io/input/AbstractInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/AbstractInputStream.java
@@ -32,6 +32,13 @@ public abstract class AbstractInputStream extends InputStream {
*/
private boolean closed;
+ /**
+ * Constructs a new instance for subclasses.
+ */
+ public AbstractInputStream() {
+ // empty
+ }
+
/**
* Checks if this instance is closed and throws an IOException if so.
*
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 de7451fdd..02ba14b58 100644
--- a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
@@ -62,6 +62,13 @@ public class AutoCloseInputStream extends ProxyInputStream {
// @formatter:on
public static class Builder extends AbstractBuilder<AutoCloseInputStream, Builder> {
+ /**
+ * Constructs a new builder of {@link AutoCloseInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link AutoCloseInputStream}.
* <p>
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 63c0275e1..43607ded6 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -141,6 +141,13 @@ public class BOMInputStream extends ProxyInputStream {
private boolean include;
+ /**
+ * Constructs a new builder of {@link BOMInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link BOMInputStream}.
* <p>
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 d23cf5696..1ea3ff5ee 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -242,6 +242,13 @@ public class BoundedInputStream extends ProxyInputStream {
//@formatter:on
public static class Builder extends AbstractBuilder<Builder> {
+ /**
+ * Constructs a new builder of {@link BoundedInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link BoundedInputStream}.
* <p>
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 b92eba0ad..afa14c4e7 100644
--- a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
@@ -75,6 +75,13 @@ public final class BufferedFileChannelInputStream extends InputStream {
private FileChannel fileChannel;
+ /**
+ * Constructs a new builder of {@link BufferedFileChannelInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link BufferedFileChannelInputStream}.
* <p>
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 020424620..05be82f92 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -85,6 +85,13 @@ public class CharSequenceInputStream extends InputStream {
private CharsetEncoder charsetEncoder = newEncoder(getCharset());
+ /**
+ * Constructs a new builder of {@link CharSequenceInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link CharSequenceInputStream}.
* <p>
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 0f9a213a6..b8b92fda9 100644
--- a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
@@ -118,6 +118,13 @@ public final class ChecksumInputStream extends CountingInputStream {
*/
private long expectedChecksumValue;
+ /**
+ * Constructs a new builder of {@link ChecksumInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link ChecksumInputStream}.
* <p>
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 4363d9599..e986dee17 100644
--- a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
@@ -92,7 +92,7 @@ public final class MemoryMappedFileInputStream extends AbstractInputStream {
public static class Builder extends AbstractStreamBuilder<MemoryMappedFileInputStream, Builder> {
/**
- * Constructs a new {@link Builder}.
+ * Constructs a new builder of {@link MemoryMappedFileInputStream}.
*/
public Builder() {
setBufferSizeDefault(DEFAULT_BUFFER_SIZE);
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 0413b4114..6b6255701 100644
--- a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
@@ -69,7 +69,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream {
private MessageDigest messageDigest;
/**
- * Constructs a new {@link Builder}.
+ * Constructs a new builder of {@link MessageDigestCalculatingInputStream}.
* <p>
* The default for compatibility is the MD5 cryptographic algorithm which is weak and should not be used.
* </p>
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 b3a0082fd..92089cda7 100644
--- a/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
@@ -76,7 +76,7 @@ public final class MessageDigestInputStream extends ObservableInputStream {
private MessageDigest messageDigest;
/**
- * Constructs a new {@link Builder}.
+ * Constructs a new builder of {@link MessageDigestInputStream}.
*/
public Builder() {
// empty
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 7be7b7a2c..14f39f21e 100644
--- a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
@@ -72,6 +72,13 @@ public class ObservableInputStream extends ProxyInputStream {
*/
public static class Builder extends AbstractBuilder<Builder> {
+ /**
+ * Constructs a new builder of {@link ObservableInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
@Override
public ObservableInputStream get() throws IOException {
return new ObservableInputStream(this);
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 e529a21f3..8dfa2391d 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -57,6 +57,13 @@ public abstract class ProxyInputStream extends FilterInputStream {
private IOIntConsumer afterRead;
+ /**
+ * Constructs a builder of {@code T}.
+ */
+ protected AbstractBuilder() {
+ // empty
+ }
+
/**
* Gets the {@link ProxyInputStream#afterRead(int)} consumer.
*
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 874e7a7f1..bb175cfae 100644
--- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
@@ -84,6 +84,13 @@ public class QueueInputStream extends InputStream {
private BlockingQueue<Integer> blockingQueue = new LinkedBlockingQueue<>();
private Duration timeout = Duration.ZERO;
+ /**
+ * Constructs a new builder of {@link QueueInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link QueueInputStream}.
* <p>
diff --git a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
index 522ac4606..facc70318 100644
--- a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
@@ -59,6 +59,13 @@ public class RandomAccessFileInputStream extends AbstractInputStream {
// private RandomAccessFile randomAccessFile;
private boolean propagateClose;
+ /**
+ * Constructs a new builder of {@link RandomAccessFileInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link RandomAccessFileInputStream}.
* <p>
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 86dae2d65..39a9d13b9 100644
--- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
@@ -71,6 +71,13 @@ public class ReadAheadInputStream extends FilterInputStream {
private ExecutorService executorService;
+ /**
+ * Constructs a new builder of {@link ReadAheadInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link ReadAheadInputStream}.
* <p>
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 e493884a1..d28ae6434 100644
--- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -109,6 +109,13 @@ public class ReaderInputStream extends AbstractInputStream {
private CharsetEncoder charsetEncoder = newEncoder(getCharset());
+ /**
+ * Constructs a new builder of {@link ReaderInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link ReaderInputStream}.
*
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 412e89b23..a8a2ee2ca 100644
--- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
+++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
@@ -88,7 +88,7 @@ public class ReversedLinesFileReader implements Closeable, IOIterable<String> {
public static class Builder extends AbstractStreamBuilder<ReversedLinesFileReader, Builder> {
/**
- * Constructs a new {@link Builder}.
+ * Constructs a new builder of {@link ReversedLinesFileReader}.
*/
public Builder() {
setBufferSizeDefault(DEFAULT_BLOCK_SIZE);
@@ -480,6 +480,38 @@ public class ReversedLinesFileReader implements Closeable, IOIterable<String> {
channel.close();
}
+ @Override
+ public IOIterator<String> iterator() {
+ return new IOIterator<String>() {
+
+ private String next;
+
+ @Override
+ public boolean hasNext() throws IOException {
+ if (next == null) {
+ next = readLine();
+ }
+ return next != null;
+ }
+
+ @Override
+ public String next() throws IOException {
+ if (next == null) {
+ next = readLine();
+ }
+ final String tmp = next;
+ next = null;
+ return tmp;
+ }
+
+ @Override
+ public Iterator<String> unwrap() {
+ return null;
+ }
+
+ };
+ }
+
/**
* Returns the lines of the file from bottom to top.
*
@@ -552,36 +584,4 @@ public class ReversedLinesFileReader implements Closeable, IOIterable<String> {
return lines.isEmpty() ? EMPTY_STRING : String.join(System.lineSeparator(), lines) + System.lineSeparator();
}
- @Override
- public IOIterator<String> iterator() {
- return new IOIterator<String>() {
-
- private String next;
-
- @Override
- public boolean hasNext() throws IOException {
- if (next == null) {
- next = readLine();
- }
- return next != null;
- }
-
- @Override
- public String next() throws IOException {
- if (next == null) {
- next = readLine();
- }
- final String tmp = next;
- next = null;
- return tmp;
- }
-
- @Override
- public Iterator<String> unwrap() {
- return null;
- }
-
- };
- }
-
}
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 d56e7db4f..f45fee3d2 100644
--- a/src/main/java/org/apache/commons/io/input/Tailer.java
+++ b/src/main/java/org/apache/commons/io/input/Tailer.java
@@ -188,6 +188,13 @@ public class Tailer implements Runnable, AutoCloseable {
private boolean startThread = true;
private ExecutorService executorService = Executors.newSingleThreadExecutor(Builder::newDaemonThread);
+ /**
+ * Constructs a new builder of {@link Tailer}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link Tailer}.
*
diff --git a/src/main/java/org/apache/commons/io/input/TailerListenerAdapter.java b/src/main/java/org/apache/commons/io/input/TailerListenerAdapter.java
index 51b7d9c37..c96fd9641 100644
--- a/src/main/java/org/apache/commons/io/input/TailerListenerAdapter.java
+++ b/src/main/java/org/apache/commons/io/input/TailerListenerAdapter.java
@@ -23,6 +23,13 @@ package org.apache.commons.io.input;
*/
public class TailerListenerAdapter implements TailerListener {
+ /**
+ * Constructs a new instance.
+ */
+ public TailerListenerAdapter() {
+ // empty
+ }
+
/**
* Called each time the Tailer reaches the end of the file.
*
diff --git a/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java b/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
index 28770e161..52fe9e9e1 100644
--- a/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
@@ -79,6 +79,13 @@ public final class ThrottledInputStream extends CountingInputStream {
*/
private double maxBytesPerSecond = Double.MAX_VALUE;
+ /**
+ * Constructs a new builder of {@link ThrottledInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link ThrottledInputStream}.
* <p>
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 052c20a7f..53f456512 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
@@ -70,6 +70,13 @@ public final class UncheckedBufferedReader extends BufferedReader {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UncheckedBufferedReader, Builder> {
+ /**
+ * Constructs a new builder of {@link UncheckedBufferedReader}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UncheckedBufferedReader}.
*
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 3fa049863..8058caf13 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
@@ -66,6 +66,13 @@ public final class UncheckedFilterInputStream extends FilterInputStream {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UncheckedFilterInputStream, Builder> {
+ /**
+ * Constructs a new builder of {@link UncheckedFilterInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UncheckedFilterInputStream}.
* <p>
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 176e8bcc2..975e908ff 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java
@@ -66,6 +66,13 @@ public final class UncheckedFilterReader extends FilterReader {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UncheckedFilterReader, Builder> {
+ /**
+ * Constructs a new builder of {@link UncheckedFilterReader}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UncheckedFilterReader}.
* <p>
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 c715daefc..234690171 100644
--- a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
@@ -83,6 +83,13 @@ public final class UnsynchronizedBufferedInputStream extends UnsynchronizedFilte
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UnsynchronizedBufferedInputStream, Builder> {
+ /**
+ * Constructs a builder of {@link UnsynchronizedBufferedInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UnsynchronizedBufferedInputStream}.
* <p>
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 49a22bd27..f4f691190 100644
--- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java
@@ -84,6 +84,13 @@ public class UnsynchronizedByteArrayInputStream extends InputStream {
private int offset;
private int length;
+ /**
+ * Constructs a builder of {@link UnsynchronizedByteArrayInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UnsynchronizedByteArrayInputStream}.
* <p>
diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java
index fd199ceb4..bfe489bb6 100644
--- a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java
@@ -70,6 +70,13 @@ public class UnsynchronizedFilterInputStream extends InputStream {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UnsynchronizedFilterInputStream, Builder> {
+ /**
+ * Constructs a new builder of {@link UnsynchronizedFilterInputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UnsynchronizedFilterInputStream}.
* <p>
diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedReader.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedReader.java
index 73f0bb842..5f3be9ab2 100644
--- a/src/main/java/org/apache/commons/io/input/UnsynchronizedReader.java
+++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedReader.java
@@ -46,6 +46,13 @@ public abstract class UnsynchronizedReader extends Reader {
*/
private char skipBuffer[];
+ /**
+ * Constructs a new instance.
+ */
+ public UnsynchronizedReader() {
+ // empty
+ }
+
/**
* Checks if this instance is closed and throws an IOException if so.
*
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 5e33c89c2..8640abfa9 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -123,6 +123,13 @@ public class XmlStreamReader extends Reader {
private boolean lenient = true;
private String httpContentType;
+ /**
+ * Constructs a new builder of {@link XmlStreamReader}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link XmlStreamWriter}.
* <p>
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 c6d464313..74a7b7c20 100644
--- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
@@ -64,6 +64,13 @@ public class ChunkedOutputStream extends FilterOutputStream {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<ChunkedOutputStream, Builder> {
+ /**
+ * Constructs a new builder of {@link ChunkedOutputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UnsynchronizedByteArrayOutputStream}.
* <p>
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 73de7c9ea..7a967244f 100644
--- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
@@ -84,7 +84,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream {
private Path directory;
/**
- * Constructs a new builder.
+ * Constructs a new builder of {@link DeferredFileOutputStream}.
*/
public Builder() {
setBufferSizeDefault(AbstractByteArrayOutputStream.DEFAULT_SIZE);
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 5d46d8bcc..262b08607 100644
--- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
+++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
@@ -87,6 +87,13 @@ public class FileWriterWithEncoding extends ProxyWriter {
private CharsetEncoder charsetEncoder = super.getCharset().newEncoder();
+ /**
+ * Constructs a new builder of {@link FileWriterWithEncoding}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link FileWriterWithEncoding}.
* <p>
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 6032f04bb..3e406473b 100644
--- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
+++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
@@ -77,7 +77,7 @@ public class LockableFileWriter extends Writer {
private AbstractOrigin<?, ?> lockDirectory = newFileOrigin(FileUtils.getTempDirectoryPath());
/**
- * Builds a new {@link LockableFileWriter}.
+ * Constructs a new builder of {@link LockableFileWriter}.
*/
public Builder() {
setBufferSizeDefault(AbstractByteArrayOutputStream.DEFAULT_SIZE);
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 cfcceb02b..34bb3515b 100644
--- a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java
@@ -64,6 +64,13 @@ public final class UncheckedFilterOutputStream extends FilterOutputStream {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UncheckedFilterOutputStream, Builder> {
+ /**
+ * Constructs a new builder of {@link UncheckedFilterOutputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UncheckedFilterOutputStream}.
* <p>
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 b9e25897f..531044f5b 100644
--- a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
+++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java
@@ -65,6 +65,13 @@ public final class UncheckedFilterWriter extends FilterWriter {
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UncheckedFilterWriter, Builder> {
+ /**
+ * Constructs a builder of {@link UncheckedFilterWriter}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UncheckedFilterWriter}.
* <p>
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 cd0b231fa..429d8162c 100644
--- a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
@@ -64,6 +64,13 @@ public final class UnsynchronizedByteArrayOutputStream extends AbstractByteArray
// @formatter:on
public static class Builder extends AbstractStreamBuilder<UnsynchronizedByteArrayOutputStream, Builder> {
+ /**
+ * Constructs a new builder of {@link UnsynchronizedByteArrayOutputStream}.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new {@link UnsynchronizedByteArrayOutputStream}.
*
diff --git a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
index 115231ebe..f767ed36b 100644
--- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
@@ -108,7 +108,7 @@ public class WriterOutputStream extends OutputStream {
private boolean writeImmediately;
/**
- * Constructs a new Builder.
+ * Constructs a new builder of {@link WriterOutputStream}.
*/
public Builder() {
this.charsetDecoder = getCharset().newDecoder();
diff --git a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
index a8ccc2499..060b6234a 100644
--- a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
+++ b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
@@ -68,7 +68,7 @@ public class XmlStreamWriter extends Writer {
public static class Builder extends AbstractStreamBuilder<XmlStreamWriter, Builder> {
/**
- * Constructs a new {@link Builder}.
+ * Constructs a new builder of {@link XmlStreamWriter}.
*/
public Builder() {
setCharsetDefault(StandardCharsets.UTF_8);
diff --git a/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java b/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java
index 9c9317248..d627d6f8f 100644
--- a/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java
+++ b/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java
@@ -107,7 +107,7 @@ public class ValidatingObjectInputStream extends ObjectInputStream {
private ObjectStreamClassPredicate predicate = new ObjectStreamClassPredicate();
/**
- * Constructs a new instance.
+ * Constructs a new builder of {@link ValidatingObjectInputStream}.
*
* @deprecated Use {@link #builder()}.
*/