org.apache.commons.io.output

类 ProxyOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.commons.io.output.ProxyOutputStream

所有已实现的接口:

Closeable, Flushable, AutoCloseable

直接已知子类:

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.

字段概要

从类继承的字段 java.io.FilterOutputStream

out

构造器概要

构造器

构造器和说明
ProxyOutputStream(OutputStream proxy) Constructs a new ProxyOutputStream.

方法概要

限定符和类型	方法和说明
protected void	afterWrite(int n) Invoked by the write methods after the proxied call has returned successfully.
protected void	beforeWrite(int n) Invoked by the write methods before the call is proxied.
void	close() Invokes the delegate's close() method.
void	flush() Invokes the delegate's flush() method.
protected void	handleIOException(IOException e) Handle any IOExceptions thrown.
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 idx) Invokes the delegate's write(int) method.

从类继承的方法 java.lang.Object

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

构造器详细资料

ProxyOutputStream

public ProxyOutputStream(OutputStream proxy)

Constructs a new ProxyOutputStream.

参数:

proxy - the OutputStream to delegate to

方法详细资料

write

public void write(int idx)
           throws IOException

Invokes the delegate's write(int) method.

覆盖:

write 在类中 FilterOutputStream

参数:

idx - the byte to write

抛出:

IOException - if an I/O error occurs

write

public void write(byte[] bts)
           throws IOException

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

覆盖:

write 在类中 FilterOutputStream

参数:

bts - the bytes to write

抛出:

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.

覆盖:

write 在类中 FilterOutputStream

参数:

bts - the bytes to write

st - The start offset

end - The number of bytes to write

抛出:

IOException - if an I/O error occurs

flush

public void flush()
           throws IOException

Invokes the delegate's flush() method.

指定者:

flush 在接口中 Flushable

覆盖:

flush 在类中 FilterOutputStream

抛出:

IOException - if an I/O error occurs

close

public void close()
           throws IOException

Invokes the delegate's close() method.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 FilterOutputStream

抛出:

IOException - if an I/O error occurs

beforeWrite

protected void beforeWrite(int n)
                    throws IOException

Invoked by the write methods before the call is proxied. The number of bytes to be written (1 for the write(int) method, buffer length for write(byte[]), etc.) is given as an argument.

Subclasses can override this method to add common pre-processing functionality without having to override all the write methods. The default implementation does nothing.

参数:

n - number of bytes to be written

抛出:

IOException - if the pre-processing fails

从以下版本开始:

2.0

afterWrite

protected void afterWrite(int n)
                   throws IOException

Invoked by the write methods after the proxied call has returned successfully. The number of bytes written (1 for the write(int) method, buffer length for write(byte[]), etc.) is given as an argument.

Subclasses can override this method to add common post-processing functionality without having to override all the write methods. The default implementation does nothing.

参数:

n - number of bytes written

抛出:

IOException - if the post-processing fails

从以下版本开始:

2.0

handleIOException

protected void handleIOException(IOException e)
                          throws IOException

Handle any IOExceptions thrown.

This method provides a point to implement custom exception handling. The default behaviour is to re-throw the exception.

参数:

e - The IOException thrown

抛出:

IOException - if an I/O error occurs

从以下版本开始:

2.0