org.apache.commons.io.output

Class BrokenOutputStream

java.lang.Object

java.io.OutputStream

org.apache.commons.io.output.BrokenOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class BrokenOutputStream
extends java.io.OutputStream

Always throws an exception from all OutputStream methods where IOException is declared.

This class is mostly useful for testing error handling.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.function.Supplier<java.lang.Throwable>	exceptionSupplier Supplies the exception that is thrown by all methods of this class.
static BrokenOutputStream	INSTANCE The singleton instance using a default IOException.

Constructor Summary

Constructors

Constructor and Description
BrokenOutputStream() Constructs a new stream that always throws an IOException.
BrokenOutputStream(java.io.IOException exception) Deprecated. Use BrokenOutputStream(Throwable).
BrokenOutputStream(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier) Constructs a new stream that always throws the supplied exception.
BrokenOutputStream(java.lang.Throwable exception) Constructs a new stream that always throws the given exception.

Method Summary

Modifier and Type	Method and Description
void	close() Throws the configured exception.
void	flush() Throws the configured exception.
private java.lang.RuntimeException	rethrow() Throws the configured exception from its supplier.
void	write(int b) Throws the configured exception.

Methods inherited from class java.io.OutputStream

write, write

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final BrokenOutputStream INSTANCE

The singleton instance using a default IOException.

Since:

2.12.0

exceptionSupplier

private final java.util.function.Supplier<java.lang.Throwable> exceptionSupplier

Supplies the exception that is thrown by all methods of this class.

Constructor Detail

BrokenOutputStream

public BrokenOutputStream()

Constructs a new stream that always throws an IOException.

BrokenOutputStream

@Deprecated
public BrokenOutputStream(java.io.IOException exception)

Deprecated. Use BrokenOutputStream(Throwable).

Constructs a new stream that always throws the given exception.

Parameters:

exception - the exception to be thrown.

BrokenOutputStream

public BrokenOutputStream(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier)

Constructs a new stream that always throws the supplied exception.

Parameters:

exceptionSupplier - a supplier for the IOException or RuntimeException to be thrown.

Since:

2.12.0

BrokenOutputStream

public BrokenOutputStream(java.lang.Throwable exception)

Constructs a new stream that always throws the given exception.

Parameters:

exception - the exception to be thrown.

Since:

2.16.0

Method Detail

close

public void close()
           throws java.io.IOException

Throws the configured exception.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - always throws the exception configured in a constructor.

flush

public void flush()
           throws java.io.IOException

Throws the configured exception.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException - always throws the exception configured in a constructor.

rethrow

private java.lang.RuntimeException rethrow()

Throws the configured exception from its supplier.

Returns:

Throws the configured exception from its supplier.

write

public void write(int b)
           throws java.io.IOException

Throws the configured exception.

Specified by:

write in class java.io.OutputStream

Parameters:

b - ignored.

Throws:

java.io.IOException - always throws the exception configured in a constructor.