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-compress.git
commit c523715656e70934aa8a79d50d234d9b5900c5d4
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Apr 9 18:30:09 2025 -0400
Javadoc
---
.../commons/compress/utils/CloseShieldFilterInputStream.java | 6 +++++-
.../apache/commons/compress/utils/CountingInputStream.java | 5 +++++
.../apache/commons/compress/utils/CountingOutputStream.java | 6 ++++++
.../compress/utils/FlushShieldFilterOutputStream.java | 6 ++++++
.../apache/commons/compress/utils/ServiceLoaderIterator.java | 12 ++++++++++++
.../commons/compress/utils/SkipShieldingInputStream.java | 9 ++++++++-
6 files changed, 42 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
b/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
index 9c942ed57..eddc34a93 100644
---
a/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
@@ -32,6 +32,11 @@
@Deprecated
public class CloseShieldFilterInputStream extends FilterInputStream {
+ /**
+ * Creates a {@code CloseShieldFilterInputStream} by assigning the
argument {@code in} to the field {@code this.in} so as to remember it for later
use.
+ *
+ * @param in the underlying input stream, or {@code null} if this instance
is to be created without an underlying stream.
+ */
public CloseShieldFilterInputStream(final InputStream in) {
super(in);
}
@@ -40,5 +45,4 @@ public CloseShieldFilterInputStream(final InputStream in) {
public void close() throws IOException {
// NO IMPLEMENTATION.
}
-
}
diff --git
a/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
b/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
index c1aae064c..af82be16d 100644
--- a/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
+++ b/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
@@ -33,6 +33,11 @@
public class CountingInputStream extends FilterInputStream {
private long bytesRead;
+ /**
+ * Creates a {@code CountingInputStream} by assigning the argument {@code
in} to the field {@code this.in} so as to remember it for later use.
+ *
+ * @param in the underlying input stream, or {@code null} if this instance
is to be created without an underlying stream.
+ */
public CountingInputStream(final InputStream in) {
super(in);
}
diff --git
a/src/main/java/org/apache/commons/compress/utils/CountingOutputStream.java
b/src/main/java/org/apache/commons/compress/utils/CountingOutputStream.java
index 51b2fe6bc..9ea0cfc0b 100644
--- a/src/main/java/org/apache/commons/compress/utils/CountingOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/utils/CountingOutputStream.java
@@ -33,6 +33,12 @@
public class CountingOutputStream extends FilterOutputStream {
private long bytesWritten;
+ /**
+ * Creates a {@code CountingOutputStream} filter built on top of the
specified underlying output stream.
+ *
+ * @param out the underlying output stream to be assigned to the field
{@code this.out} for later use, or {@code null} if this instance is to be
created
+ * without an underlying stream.
+ */
public CountingOutputStream(final OutputStream out) {
super(out);
}
diff --git
a/src/main/java/org/apache/commons/compress/utils/FlushShieldFilterOutputStream.java
b/src/main/java/org/apache/commons/compress/utils/FlushShieldFilterOutputStream.java
index cd17b6c03..f00013637 100644
---
a/src/main/java/org/apache/commons/compress/utils/FlushShieldFilterOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/FlushShieldFilterOutputStream.java
@@ -28,6 +28,12 @@
*/
public class FlushShieldFilterOutputStream extends FilterOutputStream {
+ /**
+ * Creates a {@code FlushShieldFilterOutputStream} filter built on top of
the specified underlying output stream.
+ *
+ * @param out the underlying output stream to be assigned to the field
{@code this.out} for later use, or {@code null} if this instance is to be
created
+ * without an underlying stream.
+ */
public FlushShieldFilterOutputStream(final OutputStream out) {
super(out);
}
diff --git
a/src/main/java/org/apache/commons/compress/utils/ServiceLoaderIterator.java
b/src/main/java/org/apache/commons/compress/utils/ServiceLoaderIterator.java
index accc79961..eb9981a4d 100644
--- a/src/main/java/org/apache/commons/compress/utils/ServiceLoaderIterator.java
+++ b/src/main/java/org/apache/commons/compress/utils/ServiceLoaderIterator.java
@@ -38,10 +38,22 @@ public class ServiceLoaderIterator<E> implements
Iterator<E> {
private final Class<E> service;
private final Iterator<E> serviceLoaderIterator;
+ /**
+ * Constructs a new instance.
+ *
+ * @param service The interface or abstract class representing the service.
+ */
public ServiceLoaderIterator(final Class<E> service) {
this(service, ClassLoader.getSystemClassLoader());
}
+ /**
+ * Constructs a new instance.
+ *
+ * @param service The interface or abstract class representing the
service.
+ * @param classLoader The class loader to be used to load
provider-configuration files and provider classes, or {@code null} if the
system class loader (or,
+ * failing that, the bootstrap class loader) is to be
used
+ */
public ServiceLoaderIterator(final Class<E> service, final ClassLoader
classLoader) {
this.service = service;
this.serviceLoaderIterator = ServiceLoader.load(service,
classLoader).iterator();
diff --git
a/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
b/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
index 8d3890e10..ebfaf0c4b 100644
---
a/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
@@ -37,10 +37,17 @@
*/
@Deprecated
public class SkipShieldingInputStream extends FilterInputStream {
+
private static final int SKIP_BUFFER_SIZE = 8192;
- // we can use a shared buffer as the content is discarded anyway
+
+ /** We can use a shared buffer as the content is discarded anyway. */
private static final byte[] SKIP_BUFFER = new byte[SKIP_BUFFER_SIZE];
+ /**
+ * Creates a {@code SkipShieldingInputStream} by assigning the argument
{@code in} to the field {@code this.in} so as to remember it for later use.
+ *
+ * @param in the underlying input stream, or {@code null} if this instance
is to be created without an underlying stream.
+ */
public SkipShieldingInputStream(final InputStream in) {
super(in);
}
