Package org.apache.commons.io.output

Class ProxyOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.commons.io.output.ProxyOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

CloseShieldOutputStream, CountingOutputStream, TaggedOutputStream, TeeOutputStream

public class ProxyOutputStream
extends FilterOutputStream

A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called. It is an alternative base class to FilterOutputStream to increase reusability.

See the protected methods for ways in which a subclass can easily decorate a stream with custom pre-, post- or error processing functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProxyOutputStream.Builder	Builds instances of ProxyOutputStream.

Constructor Summary

Constructors

Constructor	Description
ProxyOutputStream(OutputStream delegate)	Constructs a new ProxyOutputStream.

Method Summary

Modifier and Type	Method	Description
void	close()	Invokes the delegate's close() method.
void	flush()	Invokes the delegate's flush() method.
ProxyOutputStream	setReference(OutputStream out)	Sets the underlying output stream.
void	write(byte[] bts)	Invokes the delegate's write(byte[]) method.
void	write(byte[] bts, int st, int end)	Invokes the delegate's write(byte[]) method.
void	write(int b)	Invokes the delegate's write(int) method.

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

ProxyOutputStream

public ProxyOutputStream(OutputStream delegate)

Constructs a new ProxyOutputStream.

Parameters:

delegate - the OutputStream to delegate to

Method Details

close

public void close()
           throws IOException

Invokes the delegate's close() method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

flush

public void flush()
           throws IOException

Invokes the delegate's flush() method.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

setReference

public ProxyOutputStream setReference(OutputStream out)

Sets the underlying output stream.

Parameters:

out - the underlying output stream.

Returns:

this instance.

Since:

2.19.0

write

public void write(byte[] bts)
           throws IOException

Invokes the delegate's write(byte[]) method.

Overrides:

write in class FilterOutputStream

Parameters:

bts - the bytes to write

Throws:

IOException - if an I/O error occurs.

write

public void write(byte[] bts,
 int st,
 int end)
           throws IOException

Invokes the delegate's write(byte[]) method.

Overrides:

write in class FilterOutputStream

Parameters:

bts - the bytes to write

st - The start offset

end - The number of bytes to write

Throws:

IOException - if an I/O error occurs.

write

public void write(int b)
           throws IOException

Invokes the delegate's write(int) method.

Overrides:

write in class FilterOutputStream

Parameters:

b - the byte to write

Throws:

IOException - if an I/O error occurs.