[IO-826] Reimplemented add runtime exception support to broken streams (#530)

* Introduce ability to throw RuntimeExceptions from BrokenReader / BrokenOutputStream / BrokenWriter following example of BrokenInputStream.

---------

Co-authored-by: Gary Gregory <garydgregory@users.noreply.github.com>

Author: markslater

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

@@ -23,7 +23,7 @@
 import org.apache.commons.io.function.Erase;
 
 /**
- * Always throws an {@link IOException} from all the {@link InputStream} methods where the exception is declared.
+ * Always throws an exception from all {@link InputStream} methods where {@link IOException} is declared.
  * <p>
  * This class is mostly useful for testing error handling.
  * </p>
@@ -33,7 +33,7 @@
 public class BrokenInputStream extends InputStream {
 
     /**
-     * The singleton instance.
+     * The singleton instance using a default IOException.
      *
      * @since 2.12.0
      */
@@ -73,7 +73,7 @@ public BrokenInputStream(final Throwable exception) {
     }
 
     /**
-     * Constructs a new stream that always throws an {@link IOException}.
+     * Constructs a new stream that always throws the supplied exception.
      *
      * @param exceptionSupplier a supplier for the IOException or RuntimeException to be thrown.
      * @since 2.12.0
@@ -85,8 +85,8 @@ public BrokenInputStream(final Supplier<Throwable> exceptionSupplier) {
     /**
      * Throws the configured exception.
      *
-     * @return nothing
-     * @throws IOException always thrown
+     * @return nothing.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public int available() throws IOException {
@@ -96,7 +96,7 @@ public int available() throws IOException {
     /**
      * Throws the configured exception.
      *
-     * @throws IOException always thrown
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public void close() throws IOException {
@@ -106,8 +106,8 @@ public void close() throws IOException {
     /**
      * Throws the configured exception.
      *
-     * @return nothing
-     * @throws IOException always thrown
+     * @return nothing.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public int read() throws IOException {
@@ -117,7 +117,7 @@ public int read() throws IOException {
     /**
      * Throws the configured exception.
      *
-     * @throws IOException always thrown
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public synchronized void reset() throws IOException {
@@ -136,9 +136,9 @@ private RuntimeException rethrow() {
     /**
      * Throws the configured exception.
      *
-     * @param n ignored
-     * @return nothing
-     * @throws IOException always thrown
+     * @param n ignored.
+     * @return nothing.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public long skip(final long n) throws IOException {

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

@@ -20,8 +20,10 @@
 import java.io.Reader;
 import java.util.function.Supplier;
 
+import org.apache.commons.io.function.Erase;
+
 /**
- * Always throws an {@link IOException} from all the {@link Reader} methods where the exception is declared.
+ * Always throws an exception from all {@link Reader} methods where {@link IOException} is declared.
  * <p>
  * This class is mostly useful for testing error handling.
  * </p>
@@ -40,7 +42,7 @@ public class BrokenReader extends Reader {
     /**
      * A supplier for the exception that is thrown by all methods of this class.
      */
-    private final Supplier<IOException> exceptionSupplier;
+    private final Supplier<Throwable> exceptionSupplier;
 
     /**
      * Constructs a new reader that always throws an {@link IOException}.
@@ -53,87 +55,108 @@ public BrokenReader() {
      * Constructs a new reader that always throws the given exception.
      *
      * @param exception the exception to be thrown.
+     * @deprecated Use {@link #BrokenReader(Throwable)}.
      */
+    @Deprecated
     public BrokenReader(final IOException exception) {
         this(() -> exception);
     }
 
     /**
-     * Constructs a new reader that always throws an {@link IOException}
+     * Constructs a new reader that always throws the given exception.
+     *
+     * @param exception the exception to be thrown.
+     * @since 2.16.0
+     */
+    public BrokenReader(final Throwable exception) {
+        this(() -> exception);
+    }
+
+    /**
+     * Constructs a new reader that always throws the supplied exception.
      *
-     * @param exceptionSupplier a supplier for the exception to be thrown.
+     * @param exceptionSupplier a supplier for the IOException or RuntimeException to be thrown.
      * @since 2.12.0
      */
-    public BrokenReader(final Supplier<IOException> exceptionSupplier) {
+    public BrokenReader(final Supplier<Throwable> exceptionSupplier) {
         this.exceptionSupplier = exceptionSupplier;
     }
 
     /**
      * Throws the configured exception.
      *
-     * @throws IOException always thrown
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public void close() throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
     /**
      * Throws the configured exception.
      *
-     * @param readAheadLimit ignored
-     * @throws IOException always thrown
+     * @param readAheadLimit ignored.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public void mark(final int readAheadLimit) throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
     /**
      * Throws the configured exception.
      *
-     * @param cbuf ignored
-     * @param off  ignored
-     * @param len  ignored
-     * @return nothing
-     * @throws IOException always thrown
+     * @param cbuf ignored.
+     * @param off  ignored.
+     * @param len  ignored.
+     * @return nothing.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public int read(final char[] cbuf, final int off, final int len) throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
     /**
      * Throws the configured exception.
      *
-     * @return nothing
-     * @throws IOException always thrown
+     * @return nothing.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public boolean ready() throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
     /**
      * Throws the configured exception.
      *
-     * @throws IOException always thrown
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
-    public synchronized void reset() throws IOException {
-        throw exceptionSupplier.get();
+    public void reset() throws IOException {
+        throw rethrow();
+    }
+
+    /**
+     * Throws the configured exception from its supplier.
+     *
+     * @return Throws the configured exception from its supplier.
+     */
+    private RuntimeException rethrow() {
+        return Erase.rethrow(exceptionSupplier.get());
     }
 
     /**
      * Throws the configured exception.
      *
-     * @param n ignored
-     * @return nothing
-     * @throws IOException always thrown
+     * @param n ignored.
+     * @return nothing.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public long skip(final long n) throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
 }

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

@@ -20,29 +20,29 @@
 import java.io.OutputStream;
 import java.util.function.Supplier;
 
+import org.apache.commons.io.function.Erase;
+
 /**
- * Broken output stream. This stream always throws an {@link IOException} from
- * all {@link OutputStream} methods.
+ * Always throws an exception from all {@link OutputStream} methods where {@link IOException} is declared.
  * <p>
- * This class is mostly useful for testing error handling in code that uses an
- * output stream.
+ * This class is mostly useful for testing error handling.
  * </p>
  *
  * @since 2.0
  */
 public class BrokenOutputStream extends OutputStream {
 
     /**
-     * A singleton instance.
+     * The singleton instance using a default IOException.
      *
      * @since 2.12.0
      */
     public static final BrokenOutputStream INSTANCE = new BrokenOutputStream();
 
     /**
-     * A supplier for the exception that is thrown by all methods of this class.
+     * Supplies the exception that is thrown by all methods of this class.
      */
-    private final Supplier<IOException> exceptionSupplier;
+    private final Supplier<Throwable> exceptionSupplier;
 
     /**
      * Constructs a new stream that always throws an {@link IOException}.
@@ -55,50 +55,71 @@ public BrokenOutputStream() {
      * Constructs a new stream that always throws the given exception.
      *
      * @param exception the exception to be thrown.
+     * @deprecated Use {@link #BrokenOutputStream(Throwable)}.
      */
+    @Deprecated
     public BrokenOutputStream(final IOException exception) {
         this(() -> exception);
     }
 
     /**
-     * Constructs a new stream that always throws an {@link IOException}.
+     * Constructs a new stream that always throws the given exception.
      *
-     * @param exceptionSupplier a supplier for the exception to be thrown.
+     * @param exception the exception to be thrown.
+     * @since 2.16.0
+     */
+    public BrokenOutputStream(final Throwable exception) {
+        this(() -> exception);
+    }
+
+    /**
+     * Constructs a new stream that always throws the supplied exception.
+     *
+     * @param exceptionSupplier a supplier for the IOException or RuntimeException to be thrown.
      * @since 2.12.0
      */
-    public BrokenOutputStream(final Supplier<IOException> exceptionSupplier) {
+    public BrokenOutputStream(final Supplier<Throwable> exceptionSupplier) {
         this.exceptionSupplier = exceptionSupplier;
     }
 
     /**
      * Throws the configured exception.
      *
-     * @throws IOException always thrown
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public void close() throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
     /**
      * Throws the configured exception.
      *
-     * @throws IOException always thrown
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public void flush() throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
+    }
+
+    /**
+     * Throws the configured exception from its supplier.
+     *
+     * @return Throws the configured exception from its supplier.
+     */
+    private RuntimeException rethrow() {
+        return Erase.rethrow(exceptionSupplier.get());
     }
 
     /**
      * Throws the configured exception.
      *
-     * @param b ignored
-     * @throws IOException always thrown
+     * @param b ignored.
+     * @throws IOException always throws the exception configured in a constructor.
      */
     @Override
     public void write(final int b) throws IOException {
-        throw exceptionSupplier.get();
+        throw rethrow();
     }
 
 }