Package org.apache.commons.io.output
Class BrokenWriter
java.lang.Object
java.io.Writer
org.apache.commons.io.output.BrokenWriter
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
Always throws an exception from all
Writer methods where IOException is declared.
This class is mostly useful for testing error handling.
- Since:
- 2.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BrokenWriterThe singleton instance using a default IOException. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new writer that always throws anIOException.BrokenWriter(IOException exception) Deprecated.BrokenWriter(Throwable exception) Constructs a new writer that always throws the given exception.BrokenWriter(Supplier<Throwable> exceptionSupplier) Constructs a new writer that always throws the supplied exception. -
Method Summary
-
Field Details
-
INSTANCE
The singleton instance using a default IOException.- Since:
- 2.12.0
-
-
Constructor Details
-
BrokenWriter
public BrokenWriter()Constructs a new writer that always throws anIOException. -
BrokenWriter
Deprecated.Constructs a new writer that always throws the given exception.- Parameters:
exception- the exception to be thrown.
-
BrokenWriter
Constructs a new writer that always throws the supplied exception.- Parameters:
exceptionSupplier- a supplier for the IOException or RuntimeException to be thrown.- Since:
- 2.12.0
-
BrokenWriter
Constructs a new writer that always throws the given exception.- Parameters:
exception- the exception to be thrown.- Since:
- 2.16.0
-
-
Method Details
-
close
Throws the configured exception.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classWriter- Throws:
IOException- always throws the exception configured in a constructor.
-
flush
Throws the configured exception.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classWriter- Throws:
IOException- always throws the exception configured in a constructor.
-
write
Throws the configured exception.- Specified by:
writein classWriter- Parameters:
cbuf- ignored.off- ignored.len- ignored.- Throws:
IOException- always throws the exception configured in a constructor.
-
BrokenWriter(Throwable).