(commons-compress) 07/15: Javadoc

[ggregory]

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 7281efab8efd7d5158c8e8cc4e110ad5782a7660
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Apr 9 13:47:53 2025 -0400

    Javadoc
---
 .../archivers/zip/ScatterZipOutputStream.java      | 29 +++++++++++++++++++---
 1 file changed, 25 insertions(+), 4 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java
 
b/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java
index 8b87473c1..2db69f02d 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java
@@ -80,14 +80,23 @@ public ZipArchiveEntry transferToArchiveEntry() {
         }
     }
 
+    /**
+     * Writes ZIP entries to a ZIP archive.
+     */
     public static class ZipEntryWriter implements Closeable {
         private final Iterator<CompressedEntry> itemsIterator;
         private final InputStream inputStream;
 
-        public ZipEntryWriter(final ScatterZipOutputStream scatter) throws 
IOException {
-            scatter.backingStore.closeForWriting();
-            itemsIterator = scatter.items.iterator();
-            inputStream = scatter.backingStore.getInputStream();
+        /**
+         * Constructs a new instance.
+         *
+         * @param out a ScatterZipOutputStream.
+         * @throws IOException if an I/O error occurs.
+         */
+        public ZipEntryWriter(final ScatterZipOutputStream out) throws 
IOException {
+            out.backingStore.closeForWriting();
+            itemsIterator = out.items.iterator();
+            inputStream = out.backingStore.getInputStream();
         }
 
         @Override
@@ -95,6 +104,12 @@ public void close() throws IOException {
             IOUtils.close(inputStream);
         }
 
+        /**
+         * Writes the next ZIP entry to the given target.
+         *
+         * @param target Where to write.
+         * @throws IOException if an I/O error occurs.
+         */
         public void writeNextZipEntry(final ZipArchiveOutputStream target) 
throws IOException {
             final CompressedEntry compressedEntry = itemsIterator.next();
             // @formatter:off
@@ -170,6 +185,12 @@ public static ScatterZipOutputStream pathBased(final Path 
path, final int compre
 
     private ZipEntryWriter zipEntryWriter;
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param backingStore the backing store.
+     * @param streamCompressor Deflates ZIP entries.
+     */
     public ScatterZipOutputStream(final ScatterGatherBackingStore 
backingStore, final StreamCompressor streamCompressor) {
         this.backingStore = backingStore;
         this.streamCompressor = streamCompressor;