Package org.apache.commons.io.input

Class BrokenInputStream

java.lang.Object
java.io.InputStream
org.apache.commons.io.input.BrokenInputStream
All Implemented Interfaces:
Closeable, AutoCloseable
public class BrokenInputStream extends InputStream
Always throws an exception from all InputStream methods where IOException is declared.

This class is mostly useful for testing error handling.

Since:
2.0

  • Field Details

    • INSTANCE

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

    • exceptionSupplier

      private final Supplier<Throwable> exceptionSupplier
      A supplier for the exception that is thrown by all methods of this class.

  • Constructor Details

    • BrokenInputStream

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

    • BrokenInputStream

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

    • BrokenInputStream

      public BrokenInputStream(Supplier<Throwable> exceptionSupplier)
      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

    • BrokenInputStream

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

  • Method Details

    • available

      public int available() throws IOException
      Throws the configured exception.
      Overrides:
      available in class InputStream
      Returns:
      nothing.
      Throws:
      IOException - always throws the exception configured in a constructor.

    • close

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

    • read

      public int read() throws IOException
      Throws the configured exception.
      Specified by:
      read in class InputStream
      Returns:
      nothing.
      Throws:
      IOException - always throws the exception configured in a constructor.

    • reset

      public void reset() throws IOException
      Throws the configured exception.
      Overrides:
      reset in class InputStream
      Throws:
      IOException - always throws the exception configured in a constructor.

    • rethrow

      private RuntimeException rethrow()
      Throws the configured exception from its supplier.
      Returns:
      Throws the configured exception from its supplier.

    • skip

      public long skip(long n) throws IOException
      Throws the configured exception.
      Overrides:
      skip in class InputStream
      Parameters:
      n - ignored.
      Returns:
      nothing.
      Throws:
      IOException - always throws the exception configured in a constructor.