Package org.apache.commons.io.input

Class BrokenReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable
    public class BrokenReader
extends java.io.Reader
    Broken reader. This reader always throws an IOException from all the Reader methods where the exception is declared.

    This class is mostly useful for testing error handling in code that uses a reader.

    Since:
    2.7

    • Constructor Summary

      Constructors 
      Constructor Description
      BrokenReader()
      Creates a new reader that always throws an IOException
      BrokenReader​(java.io.IOException exception)
      Creates a new reader that always throws the given exception.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Throws the configured exception.
      void mark​(int readAheadLimit)
      Throws the configured exception.
      int read​(char[] cbuf, int off, int len)
      Throws the configured exception.
      boolean ready()
      Throws the configured exception.
      void reset()
      Throws the configured exception.
      long skip​(long n)
      Throws the configured exception.

      • Methods inherited from class java.io.Reader

        markSupported, nullReader, read, read, read, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BrokenReader

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

      • BrokenReader

        public BrokenReader()
        Creates a new reader that always throws an IOException

    • Method Detail

      • read

        public int read​(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException
        Throws the configured exception.
        Specified by:
        read in class java.io.Reader
        Parameters:
        cbuf - ignored
        off - ignored
        len - ignored
        Returns:
        nothing
        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.Reader
        Parameters:
        n - ignored
        Returns:
        nothing
        Throws:
        java.io.IOException - always thrown

      • ready

        public boolean ready()
              throws java.io.IOException
        Throws the configured exception.
        Overrides:
        ready in class java.io.Reader
        Returns:
        nothing
        Throws:
        java.io.IOException - always thrown

      • mark

        public void mark​(int readAheadLimit)
          throws java.io.IOException
        Throws the configured exception.
        Overrides:
        mark in class java.io.Reader
        Parameters:
        readAheadLimit - ignored
        Throws:
        java.io.IOException - always thrown

      • reset

        public void reset()
           throws java.io.IOException
        Throws the configured exception.
        Overrides:
        reset in class java.io.Reader
        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
        Specified by:
        close in class java.io.Reader
        Throws:
        java.io.IOException - always thrown