Package org.apache.commons.io.input

Class BrokenInputStream

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

    This class is mostly useful for testing error handling.

    Since:
    2.0

    • Constructor Summary

      Constructors 
      Constructor Description
      BrokenInputStream()
      Creates a new stream that always throws an IOException.
      BrokenInputStream​(java.io.IOException exception)
      Creates a new stream that always throws the given exception.
      BrokenInputStream​(java.util.function.Supplier<java.io.IOException> exceptionSupplier)
      Creates a new stream that always throws an IOException.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      Throws the configured exception.
      void close()
      Throws the configured exception.
      int read()
      Throws the configured exception.
      void reset()
      Throws the configured exception.
      long skip​(long n)
      Throws the configured exception.

      • Methods inherited from class java.io.InputStream

        mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, transferTo

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • INSTANCE

        public static final BrokenInputStream INSTANCE
        The singleton instance.
        Since:
        2.12.0

    • Constructor Detail

      • BrokenInputStream

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

      • BrokenInputStream

        public BrokenInputStream​(java.io.IOException exception)
        Creates a new stream that always throws the given exception.
        Parameters:
        exception - the exception to be thrown.

      • BrokenInputStream

        public BrokenInputStream​(java.util.function.Supplier<java.io.IOException> exceptionSupplier)
        Creates a new stream that always throws an IOException.
        Parameters:
        exceptionSupplier - a supplier for the exception to be thrown.
        Since:
        2.12.0

    • Method Detail

      • available

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

      • 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.InputStream
        Throws:
        java.io.IOException - always thrown

      • read

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

      • reset

        public void reset()
           throws java.io.IOException
        Throws the configured exception.
        Overrides:
        reset in class java.io.InputStream
        Throws:
        java.io.IOException - always thrown

      • skip

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