(commons-compress) 01/02: [COMPRESS-695] Configure ZipFile with a custom Zstd input stream implementation

[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 989000f900a58eb4f4a315d43354b5c106c94545
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Mar 23 10:16:23 2025 -0400

    [COMPRESS-695] Configure ZipFile with a custom Zstd input stream
    implementation
    
    - Javadoc
    - Refactor default to a constant
    - Use final
    - Remove extra vertical whitespace
---
 .../commons/compress/archivers/zip/ZipFile.java    | 29 +++++++++++-----------
 1 file changed, 15 insertions(+), 14 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java 
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index c0bfd7c80..f26073547 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -93,6 +93,8 @@
  */
 public class ZipFile implements Closeable {
 
+    private static final IOFunction<InputStream, InputStream> 
DEFAULT_ZSTD_INPUT_STREAM_FACTORY = ZstdCompressorInputStream::new;
+
     /**
      * Lock-free implementation of BoundedInputStream. The implementation uses 
positioned reads on the underlying archive file channel and therefore performs
      * significantly faster in concurrent environment.
@@ -139,7 +141,7 @@ public static class Builder extends 
AbstractStreamBuilder<ZipFile, Builder> {
         private boolean useUnicodeExtraFields = true;
         private boolean ignoreLocalFileHeader;
         private long maxNumberOfDisks = 1;
-        private IOFunction<InputStream, InputStream> zstdInputStream = 
ZstdCompressorInputStream::new;
+        private IOFunction<InputStream, InputStream> zstdInputStream = 
DEFAULT_ZSTD_INPUT_STREAM_FACTORY;
 
         /**
          * Constructs a new instance.
@@ -173,19 +175,18 @@ public ZipFile get() throws IOException {
         }
 
         /**
-         * This method sets the {@link IOFunction} which will be used the 
create an
-         * {@link InputStream}, which could be used to replace the officially 
supported
-         * ZSTD compression library.
+         * Sets the factory {@link IOFunction} to create a Zstd {@link 
InputStream}. Defaults to
+         * {@link 
ZstdCompressorInputStream#ZstdCompressorInputStream(InputStream)}.
+         * <p>
+         * Call this method to plugin an alternate Zstd input stream 
implementation.
+         * </p>
          *
-         * @param zstdInpStreamFactory the IOFunction which gives the ability 
to return
-         *                             a different InputStream for Zstd 
compression, if
-         *                             parameter is null than it will be set 
to default.
-         * @return {@code this} instance
+         * @param zstdInpStreamFactory the factory {@link IOFunction} to 
create a Zstd {@link InputStream}; {@code null} resets to the default.
+         * @return {@code this} instance.
          * @since 1.28.0
          */
-        public Builder setZstdInputStreamFactory(IOFunction<InputStream, 
InputStream> zstdInpStreamFactory) {
-            this.zstdInputStream = zstdInpStreamFactory == null ? 
ZstdCompressorInputStream::new : zstdInpStreamFactory;
-
+        public Builder setZstdInputStreamFactory(final IOFunction<InputStream, 
InputStream> zstdInpStreamFactory) {
+            this.zstdInputStream = zstdInpStreamFactory == null ? 
DEFAULT_ZSTD_INPUT_STREAM_FACTORY : zstdInpStreamFactory;
             return this;
         }
 
@@ -913,7 +914,7 @@ public ZipFile(final SeekableByteChannel channel, final 
String encoding) throws
     }
 
     private ZipFile(final SeekableByteChannel channel, final String 
channelDescription, final Charset encoding, final boolean useUnicodeExtraFields,
-            final boolean closeOnError, final boolean ignoreLocalFileHeader, 
IOFunction<InputStream, InputStream> zstdInputStream) throws IOException {
+            final boolean closeOnError, final boolean ignoreLocalFileHeader, 
final IOFunction<InputStream, InputStream> zstdInputStream) throws IOException {
         this.isSplitZipArchive = channel instanceof 
ZipSplitReadOnlySeekableByteChannel;
         this.encoding = Charsets.toCharset(encoding, Builder.DEFAULT_CHARSET);
         this.zipEncoding = ZipEncodingHelper.getZipEncoding(encoding);
@@ -988,8 +989,8 @@ public ZipFile(final SeekableByteChannel channel, final 
String channelDescriptio
 
     private ZipFile(final SeekableByteChannel channel, final String 
channelDescription, final String encoding, final boolean useUnicodeExtraFields,
             final boolean closeOnError, final boolean ignoreLocalFileHeader) 
throws IOException {
-        this(channel, channelDescription, Charsets.toCharset(encoding), 
useUnicodeExtraFields, closeOnError,
-                ignoreLocalFileHeader, ZstdCompressorInputStream::new);
+        this(channel, channelDescription, Charsets.toCharset(encoding), 
useUnicodeExtraFields, closeOnError, ignoreLocalFileHeader,
+                DEFAULT_ZSTD_INPUT_STREAM_FACTORY);
     }
 
     /**