Package org.apache.commons.io.input
Class BrokenReader
java.lang.Object
java.io.Reader
org.apache.commons.io.input.BrokenReader
- All Implemented Interfaces:
Closeable,AutoCloseable,Readable
Always throws an exception from all
Reader methods where IOException is declared.
This class is mostly useful for testing error handling.
- Since:
- 2.7
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BrokenReaderA singleton instance using a default IOException. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new reader that always throws anIOException.BrokenReader(IOException exception) Deprecated.BrokenReader(Throwable exception) Constructs a new reader that always throws the given exception.BrokenReader(Supplier<Throwable> exceptionSupplier) Constructs a new reader that always throws the supplied exception. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Throws the configured exception.voidmark(int readAheadLimit) Throws the configured exception.intread(char[] cbuf, int off, int len) Throws the configured exception.booleanready()Throws the configured exception.voidreset()Throws the configured exception.longskip(long n) Throws the configured exception.Methods inherited from class java.io.Reader
markSupported, read, read, read
-
Field Details
-
INSTANCE
A singleton instance using a default IOException.- Since:
- 2.12.0
-
-
Constructor Details
-
BrokenReader
public BrokenReader()Constructs a new reader that always throws anIOException. -
BrokenReader
Deprecated.Constructs a new reader that always throws the given exception.- Parameters:
exception- the exception to be thrown.
-
BrokenReader
Constructs a new reader that always throws the supplied exception.- Parameters:
exceptionSupplier- a supplier for the IOException or RuntimeException to be thrown.- Since:
- 2.12.0
-
BrokenReader
Constructs a new reader 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 classReader- Throws:
IOException- always throws the exception configured in a constructor.
-
mark
Throws the configured exception.- Overrides:
markin classReader- Parameters:
readAheadLimit- ignored.- Throws:
IOException- always throws the exception configured in a constructor.
-
read
Throws the configured exception.- Specified by:
readin classReader- Parameters:
cbuf- ignored.off- ignored.len- ignored.- Returns:
- nothing.
- Throws:
IOException- always throws the exception configured in a constructor.
-
ready
Throws the configured exception.- Overrides:
readyin classReader- Returns:
- nothing.
- Throws:
IOException- always throws the exception configured in a constructor.
-
reset
Throws the configured exception.- Overrides:
resetin classReader- Throws:
IOException- always throws the exception configured in a constructor.
-
skip
Throws the configured exception.- Overrides:
skipin classReader- Parameters:
n- ignored.- Returns:
- nothing.
- Throws:
IOException- always throws the exception configured in a constructor.
-
BrokenReader(Throwable).