Package org.apache.commons.io.output

Class BrokenWriter

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
    public class BrokenWriter
extends java.io.Writer
    Broken writer. This writer always throws an IOException from all Writer methods.

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

    Since:
    2.0

    • Field Summary

      • Fields inherited from class java.io.Writer

        lock

    • Constructor Summary

      Constructors 
      Constructor Description
      BrokenWriter()
      Creates a new writer that always throws an IOException
      BrokenWriter​(java.io.IOException exception)
      Creates a new writer 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 flush()
      Throws the configured exception.
      void write​(char[] cbuf, int off, int len)
      Throws the configured exception.

      • Methods inherited from class java.io.Writer

        append, append, append, nullWriter, write, write, write, write

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BrokenWriter

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

      • BrokenWriter

        public BrokenWriter()
        Creates a new writer that always throws an IOException

    • Method Detail

      • write

        public void write​(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException
        Throws the configured exception.
        Specified by:
        write in class java.io.Writer
        Parameters:
        cbuf - ignored
        off - ignored
        len - ignored
        Throws:
        java.io.IOException - always thrown

      • flush

        public void flush()
           throws java.io.IOException
        Throws the configured exception.
        Specified by:
        flush in interface java.io.Flushable
        Specified by:
        flush in class java.io.Writer
        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.Writer
        Throws:
        java.io.IOException - always thrown