Add AbstractStreamBuilder.setOpenOptions(OpenOption...)

Author: garydgregory

src/changes/changes.xml

@@ -56,6 +56,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="fix" due-to="Gary Gregory">
         Add CharSequenceInputStream.Builder.
       </action>
+      <action dev="ggregory" type="fix" due-to="Gary Gregory">
+        Add AbstractStreamBuilder.setOpenOptions(OpenOption...).
+      </action>
       <!-- UPDATE -->
     </release>
     <release version="2.12.0" date="2023-05-13" description="Java 8 required.">

src/main/java/org/apache/commons/io/build/AbstractOrigin.java

@@ -293,7 +293,7 @@ public byte[] getByteArray() throws IOException {
      * @throws UnsupportedOperationException if this method is not implemented in a concrete subclass.
      */
     public File getFile() {
-        throw new UnsupportedOperationException(origin.toString());
+        throw new UnsupportedOperationException("getFile() from " + origin.toString());
     }
 
     /**
@@ -327,7 +327,7 @@ public OutputStream getOutputStream(final OpenOption... options) throws IOExcept
      * @throws UnsupportedOperationException if this method is not implemented in a concrete subclass.
      */
     public Path getPath() {
-        throw new UnsupportedOperationException(origin.toString());
+        throw new UnsupportedOperationException("getPath() from " + origin.toString());
     }
 
     /**

src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java

@@ -17,10 +17,16 @@
 
 package org.apache.commons.io.build;
 
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Writer;
 import java.nio.charset.Charset;
+import java.nio.file.OpenOption;
 
 import org.apache.commons.io.Charsets;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.file.PathUtils;
 
 /**
  * Abstracts building a typed instance of {@code T}.
@@ -31,6 +37,8 @@
  */
 public abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T, B>> extends AbstractOriginSupplier<T, B> {
 
+    private static final OpenOption[] DEFAULT_OPEN_OPTIONS = PathUtils.EMPTY_OPEN_OPTION_ARRAY;
+
     /**
      * The buffer size, defaults to {@link IOUtils#DEFAULT_BUFFER_SIZE} ({@value IOUtils#DEFAULT_BUFFER_SIZE}).
      */
@@ -51,6 +59,8 @@ public abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T
      */
     private Charset charsetDefault = Charset.defaultCharset();
 
+    private OpenOption[] openOptions = DEFAULT_OPEN_OPTIONS;
+
     /**
      * Gets the buffer size, defaults to {@link IOUtils#DEFAULT_BUFFER_SIZE} ({@value IOUtils#DEFAULT_BUFFER_SIZE}).
      *
@@ -87,6 +97,49 @@ protected Charset getCharsetDefault() {
         return charsetDefault;
     }
 
+    /**
+     * Gets an input stream from the origin with open options.
+     *
+     * @return An input stream
+     * @throws IOException                   if an I/O error occurs.
+     * @throws UnsupportedOperationException if the origin cannot be converted to an InputStream.
+     * @see AbstractOrigin#getInputStream(OpenOption...)
+     * @since 2.13.0
+     */
+    protected InputStream getInputStream() throws IOException {
+        return getOrigin().getInputStream(getOpenOptions());
+    }
+
+    protected OpenOption[] getOpenOptions() {
+        return openOptions;
+    }
+
+    /**
+     * Gets an output stream from the origin with open options.
+     *
+     * @return An input stream
+     * @throws IOException                   if an I/O error occurs.
+     * @throws UnsupportedOperationException if the origin cannot be converted to an OututStream.
+     * @see AbstractOrigin#getOutputStream(OpenOption...)
+     * @since 2.13.0
+     */
+    protected OutputStream getOutputStream() throws IOException {
+        return getOrigin().getOutputStream(getOpenOptions());
+    }
+
+    /**
+     * Gets an writer from the origin with open options.
+     *
+     * @return An writer.
+     * @throws IOException                   if an I/O error occurs.
+     * @throws UnsupportedOperationException if the origin cannot be converted to a Writer.
+     * @see AbstractOrigin#getOutputStream(OpenOption...)
+     * @since 2.13.0
+     */
+    protected Writer getWriter() throws IOException {
+        return getOrigin().getWriter(getCharset(), getOpenOptions());
+    }
+
     /**
      * Sets the buffer size.
      * <p>
@@ -169,4 +222,25 @@ protected B setCharsetDefault(final Charset defaultCharset) {
         this.charsetDefault = defaultCharset;
         return asThis();
     }
+
+    /**
+     * Sets the OpenOption[].
+     * <p>
+     * Normally used with InputStream, OutputStream, and Writer.
+     * </p>
+     * <p>
+     * Subclasses may ignore this setting.
+     * </p>
+     *
+     * @param openOptions the OpenOption[] name, null resets to the default.
+     * @return this.
+     * @since 2.13.0
+     * @see #setInputStream(InputStream)
+     * @see #setOutputStream(OutputStream)
+     * @see #setWriter(Writer)
+     */
+    public B setOpenOptions(final OpenOption... openOptions) {
+        this.openOptions = openOptions != null ? openOptions : DEFAULT_OPEN_OPTIONS;
+        return asThis();
+    }
 }

src/main/java/org/apache/commons/io/input/BOMInputStream.java

@@ -20,15 +20,13 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.nio.file.OpenOption;
 import java.util.Arrays;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Objects;
 
 import org.apache.commons.io.ByteOrderMark;
 import org.apache.commons.io.IOUtils;
-import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -136,7 +134,7 @@ static ByteOrderMark getDefaultByteOrderMark() {
         /**
          * Constructs a new instance.
          * <p>
-         * This builder use the aspects InputStream, include, and ByteOrderMark[].
+         * This builder use the aspects InputStream, OpenOption[], include, and ByteOrderMark[].
          * </p>
          * <p>
          * You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
@@ -145,12 +143,12 @@ static ByteOrderMark getDefaultByteOrderMark() {
          *
          * @return a new instance.
          * @throws UnsupportedOperationException if the origin cannot provide an InputStream.
-         * @see AbstractOrigin#getInputStream(OpenOption...)
+         * @see #getInputStream()
          */
         @SuppressWarnings("resource")
         @Override
         public BOMInputStream get() throws IOException {
-            return new BOMInputStream(getOrigin().getInputStream(), include, byteOrderMarks);
+            return new BOMInputStream(getInputStream(), include, byteOrderMarks);
         }
 
         /**

src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java

@@ -18,12 +18,10 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.nio.file.OpenOption;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.security.Provider;
 
-import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -75,7 +73,7 @@ public Builder() {
         /**
          * Constructs a new instance.
          * <p>
-         * This builder use the aspects InputStream and MessageDigest.
+         * This builder use the aspects InputStream, OpenOption[], and MessageDigest.
          * </p>
          * <p>
          * You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
@@ -84,12 +82,12 @@ public Builder() {
          *
          * @return a new instance.
          * @throws UnsupportedOperationException if the origin cannot provide an InputStream.
-         * @see AbstractOrigin#getInputStream(OpenOption...)
+         * @see #getInputStream()
          */
         @SuppressWarnings("resource")
         @Override
         public MessageDigestCalculatingInputStream get() throws IOException {
-            return new MessageDigestCalculatingInputStream(getOrigin().getInputStream(), messageDigest);
+            return new MessageDigestCalculatingInputStream(getInputStream(), messageDigest);
         }
 
         /**

src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java

@@ -22,7 +22,6 @@
 import java.io.InputStream;
 import java.io.InterruptedIOException;
 import java.nio.ByteBuffer;
-import java.nio.file.OpenOption;
 import java.util.Objects;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -31,7 +30,6 @@
 import java.util.concurrent.locks.Condition;
 import java.util.concurrent.locks.ReentrantLock;
 
-import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -71,7 +69,7 @@ public static class Builder extends AbstractStreamBuilder<ReadAheadInputStream,
         /**
          * Constructs a new instance.
          * <p>
-         * This builder use the aspects InputStream, buffer size, ExecutorService.
+         * This builder use the aspects InputStream, OpenOption[], buffer size, ExecutorService.
          * </p>
          * <p>
          * You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
@@ -80,12 +78,12 @@ public static class Builder extends AbstractStreamBuilder<ReadAheadInputStream,
          *
          * @return a new instance.
          * @throws UnsupportedOperationException if the origin cannot provide an InputStream.
-         * @see AbstractOrigin#getInputStream(OpenOption...)
+         * @see #getInputStream()
          */
         @SuppressWarnings("resource")
         @Override
         public ReadAheadInputStream get() throws IOException {
-            return new ReadAheadInputStream(getOrigin().getInputStream(), getBufferSize(), executorService != null ? executorService : newExecutorService(),
+            return new ReadAheadInputStream(getInputStream(), getBufferSize(), executorService != null ? executorService : newExecutorService(),
                     executorService == null);
         }
 

src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java

@@ -22,9 +22,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.UncheckedIOException;
-import java.nio.file.OpenOption;
 
-import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 import org.apache.commons.io.function.Uncheck;
 
@@ -65,7 +63,7 @@ public static class Builder extends AbstractStreamBuilder<UncheckedFilterInputSt
         /**
          * Constructs a new instance.
          * <p>
-         * This builder use the aspect InputStream.
+         * This builder use the aspect InputStream and OpenOption[].
          * </p>
          * <p>
          * You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
@@ -74,12 +72,12 @@ public static class Builder extends AbstractStreamBuilder<UncheckedFilterInputSt
          *
          * @return a new instance.
          * @throws UnsupportedOperationException if the origin cannot provide an InputStream.
-         * @see AbstractOrigin#getInputStream(OpenOption...)
+         * @see #getInputStream()
          */
         @Override
         public UncheckedFilterInputStream get() {
             // This an unchecked class, so this method is as well.
-            return Uncheck.get(() -> new UncheckedFilterInputStream(getOrigin().getInputStream()));
+            return Uncheck.get(() -> new UncheckedFilterInputStream(getInputStream()));
         }
 
     }

src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java

@@ -20,10 +20,8 @@
 import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.nio.file.OpenOption;
 
 import org.apache.commons.io.IOUtils;
-import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -82,7 +80,7 @@ public static class Builder extends AbstractStreamBuilder<UnsynchronizedBuffered
         /**
          * Constructs a new instance.
          * <p>
-         * This builder use the aspects InputStream and buffer size.
+         * This builder use the aspects InputStream, OpenOption[] and buffer size.
          * </p>
          * <p>
          * You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
@@ -91,12 +89,12 @@ public static class Builder extends AbstractStreamBuilder<UnsynchronizedBuffered
          *
          * @return a new instance.
          * @throws UnsupportedOperationException if the origin cannot provide an InputStream.
-         * @see AbstractOrigin#getInputStream(OpenOption...)
+         * @see #getInputStream()
          */
         @SuppressWarnings("resource") // Caller closes.
         @Override
         public UnsynchronizedBufferedInputStream get() throws IOException {
-            return new UnsynchronizedBufferedInputStream(getOrigin().getInputStream(), getBufferSize());
+            return new UnsynchronizedBufferedInputStream(getInputStream(), getBufferSize());
         }
 
     }

src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java

@@ -20,9 +20,7 @@
 import java.io.FilterInputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.nio.file.OpenOption;
 
-import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -69,7 +67,7 @@ public static class Builder extends AbstractStreamBuilder<UnsynchronizedFilterIn
         /**
          * Constructs a new instance.
          * <p>
-         * This builder use the aspect InputStream.
+         * This builder use the aspect InputStream and OpenOption[].
          * </p>
          * <p>
          * You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
@@ -78,12 +76,12 @@ public static class Builder extends AbstractStreamBuilder<UnsynchronizedFilterIn
          *
          * @return a new instance.
          * @throws UnsupportedOperationException if the origin cannot provide an InputStream.
-         * @see AbstractOrigin#getInputStream(OpenOption...)
+         * @see #getInputStream()
          */
         @SuppressWarnings("resource") // Caller closes.
         @Override
         public UnsynchronizedFilterInputStream get() throws IOException {
-            return new UnsynchronizedFilterInputStream(getOrigin().getInputStream());
+            return new UnsynchronizedFilterInputStream(getInputStream());
         }
 
     }