Prevent IllegalArgumentExceptions in BrokenInputStream/Reader/OutputStream/Writer (#278)

* BrokenInputStream/Reader/OutputStream/Writer use a supplier to prevent IllegalArgumentExceptions in try-with-resources

* Processed feedback from PR

Author: robtimus

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

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.function.Supplier;
 
 /**
  * Always throws an {@link IOException} from all the {@link InputStream} methods where the exception is declared.
@@ -37,24 +38,34 @@ public class BrokenInputStream extends InputStream {
     public static final BrokenInputStream INSTANCE = new BrokenInputStream();
 
     /**
-     * The exception that is thrown by all methods of this class.
+     * A supplier for the exception that is thrown by all methods of this class.
      */
-    private final IOException exception;
+    private final Supplier<IOException> exceptionSupplier;
 
     /**
-     * Creates a new stream that always throws an {@link IOException}
+     * Creates a new stream that always throws an {@link IOException}.
      */
     public BrokenInputStream() {
-        this(new IOException("Broken input stream"));
+        this(() -> new IOException("Broken input stream"));
     }
 
     /**
      * Creates a new stream that always throws the given exception.
      *
-     * @param exception the exception to be thrown
+     * @param exception the exception to be thrown.
      */
     public BrokenInputStream(final IOException exception) {
-        this.exception = exception;
+        this(() -> exception);
+    }
+
+    /**
+     * Creates a new stream that always throws an {@link IOException}.
+     *
+     * @param exceptionSupplier a supplier for the exception to be thrown.
+     * @since 2.12.0
+     */
+    public BrokenInputStream(final Supplier<IOException> exceptionSupplier) {
+        this.exceptionSupplier = exceptionSupplier;
     }
 
     /**
@@ -65,7 +76,7 @@ public BrokenInputStream(final IOException exception) {
      */
     @Override
     public int available() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -75,7 +86,7 @@ public int available() throws IOException {
      */
     @Override
     public void close() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -86,7 +97,7 @@ public void close() throws IOException {
      */
     @Override
     public int read() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -96,7 +107,7 @@ public int read() throws IOException {
      */
     @Override
     public synchronized void reset() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -108,7 +119,7 @@ public synchronized void reset() throws IOException {
      */
     @Override
     public long skip(final long n) throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
 }

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

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.io.Reader;
+import java.util.function.Supplier;
 
 /**
  * Always throws an {@link IOException} from all the {@link Reader} methods where the exception is declared.
@@ -37,24 +38,34 @@ public class BrokenReader extends Reader {
     public static final BrokenReader INSTANCE = new BrokenReader();
 
     /**
-     * The exception that is thrown by all methods of this class.
+     * A supplier for the exception that is thrown by all methods of this class.
      */
-    private final IOException exception;
+    private final Supplier<IOException> exceptionSupplier;
 
     /**
-     * Creates a new reader that always throws an {@link IOException}
+     * Creates a new reader that always throws an {@link IOException}.
      */
     public BrokenReader() {
-        this(new IOException("Broken reader"));
+        this(() -> new IOException("Broken reader"));
     }
 
     /**
      * Creates a new reader that always throws the given exception.
      *
-     * @param exception the exception to be thrown
+     * @param exception the exception to be thrown.
      */
     public BrokenReader(final IOException exception) {
-        this.exception = exception;
+        this(() -> exception);
+    }
+
+    /**
+     * Creates a new reader that always throws an {@link IOException}
+     *
+     * @param exceptionSupplier a supplier for the exception to be thrown.
+     * @since 2.12.0
+     */
+    public BrokenReader(final Supplier<IOException> exceptionSupplier) {
+        this.exceptionSupplier = exceptionSupplier;
     }
 
     /**
@@ -64,7 +75,7 @@ public BrokenReader(final IOException exception) {
      */
     @Override
     public void close() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -75,7 +86,7 @@ public void close() throws IOException {
      */
     @Override
     public void mark(final int readAheadLimit) throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -89,7 +100,7 @@ public void mark(final int readAheadLimit) throws IOException {
      */
     @Override
     public int read(final char[] cbuf, final int off, final int len) throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -100,7 +111,7 @@ public int read(final char[] cbuf, final int off, final int len) throws IOExcept
      */
     @Override
     public boolean ready() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -110,7 +121,7 @@ public boolean ready() throws IOException {
      */
     @Override
     public synchronized void reset() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -122,7 +133,7 @@ public synchronized void reset() throws IOException {
      */
     @Override
     public long skip(final long n) throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
 }

src/main/java/org/apache/commons/io/output/BrokenOutputStream.java

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.util.function.Supplier;
 
 /**
  * Broken output stream. This stream always throws an {@link IOException} from
@@ -32,24 +33,41 @@
 public class BrokenOutputStream extends OutputStream {
 
     /**
-     * The exception that is thrown by all methods of this class.
+     * A singleton instance.
+     *
+     * @since 2.12.0
      */
-    private final IOException exception;
+    public static final BrokenOutputStream INSTANCE = new BrokenOutputStream();
 
     /**
-     * Creates a new stream that always throws an {@link IOException}
+     * A supplier for the exception that is thrown by all methods of this class.
+     */
+    private final Supplier<IOException> exceptionSupplier;
+
+    /**
+     * Creates a new stream that always throws an {@link IOException}.
      */
     public BrokenOutputStream() {
-        this(new IOException("Broken output stream"));
+        this(() -> new IOException("Broken output stream"));
     }
 
     /**
      * Creates a new stream that always throws the given exception.
      *
-     * @param exception the exception to be thrown
+     * @param exception the exception to be thrown.
      */
     public BrokenOutputStream(final IOException exception) {
-        this.exception = exception;
+        this(() -> exception);
+    }
+
+    /**
+     * Creates a new stream that always throws an {@link IOException}.
+     *
+     * @param exceptionSupplier a supplier for the exception to be thrown.
+     * @since 2.12.0
+     */
+    public BrokenOutputStream(final Supplier<IOException> exceptionSupplier) {
+        this.exceptionSupplier = exceptionSupplier;
     }
 
     /**
@@ -59,7 +77,7 @@ public BrokenOutputStream(final IOException exception) {
      */
     @Override
     public void close() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -69,7 +87,7 @@ public void close() throws IOException {
      */
     @Override
     public void flush() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -80,7 +98,7 @@ public void flush() throws IOException {
      */
     @Override
     public void write(final int b) throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
 }

src/main/java/org/apache/commons/io/output/BrokenWriter.java

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.io.Writer;
+import java.util.function.Supplier;
 
 /**
  * Always throws an {@link IOException} from all {@link Writer} methods.
@@ -37,24 +38,34 @@ public class BrokenWriter extends Writer {
     public static final BrokenWriter INSTANCE = new BrokenWriter();
 
     /**
-     * The exception that is thrown by all methods of this class.
+     * A supplier for the exception that is thrown by all methods of this class.
      */
-    private final IOException exception;
+    private final Supplier<IOException> exceptionSupplier;
 
     /**
-     * Creates a new writer that always throws an {@link IOException}
+     * Creates a new writer that always throws an {@link IOException}.
      */
     public BrokenWriter() {
-        this(new IOException("Broken writer"));
+        this(() -> new IOException("Broken writer"));
     }
 
     /**
      * Creates a new writer that always throws the given exception.
      *
-     * @param exception the exception to be thrown
+     * @param exception the exception to be thrown.
      */
     public BrokenWriter(final IOException exception) {
-        this.exception = exception;
+        this(() -> exception);
+    }
+
+    /**
+     * Creates a new writer that always throws an {@link IOException}.
+     *
+     * @param exceptionSupplier a supplier for the exception to be thrown.
+     * @since 2.12.0
+     */
+    public BrokenWriter(final Supplier<IOException> exceptionSupplier) {
+        this.exceptionSupplier = exceptionSupplier;
     }
 
     /**
@@ -64,7 +75,7 @@ public BrokenWriter(final IOException exception) {
      */
     @Override
     public void close() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -74,7 +85,7 @@ public void close() throws IOException {
      */
     @Override
     public void flush() throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
     /**
@@ -87,7 +98,7 @@ public void flush() throws IOException {
      */
     @Override
     public void write(final char[] cbuf, final int off, final int len) throws IOException {
-        throw exception;
+        throw exceptionSupplier.get();
     }
 
 }

src/test/java/org/apache/commons/io/input/BrokenInputStreamTest.java

@@ -18,10 +18,8 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
-
 import java.io.IOException;
 import java.io.InputStream;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -67,4 +65,18 @@ public void testSkip() {
         assertEquals(exception, assertThrows(IOException.class, () -> stream.skip(1)));
     }
 
+    @Test
+    public void testTryWithResources() {
+        final IOException thrown = assertThrows(IOException.class, () -> {
+            try (InputStream newStream = new BrokenInputStream()) {
+                newStream.read();
+            }
+        });
+        assertEquals("Broken input stream", thrown.getMessage());
+
+        final Throwable[] suppressed = thrown.getSuppressed();
+        assertEquals(1, suppressed.length);
+        assertEquals(IOException.class, suppressed[0].getClass());
+        assertEquals("Broken input stream", suppressed[0].getMessage());
+    }
 }