Package org.apache.commons.io.output

Class BrokenOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class BrokenOutputStream
extends java.io.OutputStream
    Always throws an exception from all OutputStream methods where IOException is declared.

    This class is mostly useful for testing error handling.

    Since:
    2.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.function.Function<java.lang.String,​java.lang.Throwable> exceptionFunction
      Supplies the exception that is thrown by all methods of this class.
      static BrokenOutputStream INSTANCE
      The singleton instance using a default IOException.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Throws the configured exception.
      void flush()
      Throws the configured exception.
      private java.lang.RuntimeException rethrow​(java.lang.String method)
      Throws the configured exception from its supplier.
      void write​(int b)
      Throws the configured exception.

      • Methods inherited from class java.io.OutputStream

        nullOutputStream, write, write

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • INSTANCE

        public static final BrokenOutputStream INSTANCE
        The singleton instance using a default IOException.
        Since:
        2.12.0

      • exceptionFunction

        private final java.util.function.Function<java.lang.String,​java.lang.Throwable> exceptionFunction
        Supplies the exception that is thrown by all methods of this class.

    • Constructor Detail

      • BrokenOutputStream

        public BrokenOutputStream()
        Constructs a new stream that always throws an IOException.

      • BrokenOutputStream

        @Deprecated
public BrokenOutputStream​(java.io.IOException exception)
        Deprecated.
        Use BrokenOutputStream(Throwable).
        Constructs a new stream that always throws the given exception.
        Parameters:
        exception - the exception to be thrown.

      • BrokenOutputStream

        public BrokenOutputStream​(java.util.function.Function<java.lang.String,​java.lang.Throwable> exceptionFunction)
        Constructs a new stream that always throws the supplied exception.

        This class uses the invoked method name as the function input.

        Parameters:
        exceptionFunction - a supplier for the IOException or RuntimeException to be thrown.
        Since:
        2.19.0

      • BrokenOutputStream

        @Deprecated
public BrokenOutputStream​(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier)
        Deprecated.
        Use BrokenOutputStream(Function).
        Constructs a new stream that always throws the supplied exception.
        Parameters:
        exceptionSupplier - a supplier for the IOException or RuntimeException to be thrown.
        Since:
        2.12.0

      • BrokenOutputStream

        public BrokenOutputStream​(java.lang.Throwable exception)
        Constructs a new stream that always throws the given exception.
        Parameters:
        exception - the exception to be thrown.
        Since:
        2.16.0

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Throws the configured exception.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.OutputStream
        Throws:
        java.io.IOException - always throws the exception configured in a constructor.

      • flush

        public void flush()
           throws java.io.IOException
        Throws the configured exception.
        Specified by:
        flush in interface java.io.Flushable
        Overrides:
        flush in class java.io.OutputStream
        Throws:
        java.io.IOException - always throws the exception configured in a constructor.

      • rethrow

        private java.lang.RuntimeException rethrow​(java.lang.String method)
        Throws the configured exception from its supplier.
        Parameters:
        method - The exception function argument.
        Returns:
        Throws the configured exception from its supplier.

      • write

        public void write​(int b)
           throws java.io.IOException
        Throws the configured exception.
        Specified by:
        write in class java.io.OutputStream
        Parameters:
        b - ignored.
        Throws:
        java.io.IOException - always throws the exception configured in a constructor.