|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.io.Writer
java.io.FilterWriter
org.apache.commons.io.output.ProxyWriter
public class ProxyWriter
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 FilterWriter to increase reusability, because FilterWriter changes the methods being called, such as write(char[]) to write(char[], int, int) and write(String) to write(String, int, int).
| Field Summary |
|---|
| Fields inherited from class java.io.FilterWriter |
|---|
out |
| Fields inherited from class java.io.Writer |
|---|
lock |
| Constructor Summary | |
|---|---|
ProxyWriter(Writer proxy)
Constructs a new ProxyWriter. |
|
| Method Summary | |
|---|---|
protected void |
afterWrite(int n)
Invoked by the write methods after the proxied call has returned successfully. |
Writer |
append(char c)
Invokes the delegate's append(char) method. |
Writer |
append(CharSequence csq)
Invokes the delegate's append(CharSequence) method. |
Writer |
append(CharSequence csq,
int start,
int end)
Invokes the delegate's append(CharSequence, int, int) method. |
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(char[] chr)
Invokes the delegate's write(char[]) method. |
void |
write(char[] chr,
int st,
int len)
Invokes the delegate's write(char[], int, int) method. |
void |
write(int idx)
Invokes the delegate's write(int) method. |
void |
write(String str)
Invokes the delegate's write(String) method. |
void |
write(String str,
int st,
int len)
Invokes the delegate's write(String) method. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ProxyWriter(Writer proxy)
proxy - the Writer to delegate to| Method Detail |
|---|
public Writer append(char c)
throws IOException
append(char) method.
append in interface Appendableappend in class Writerc - The character to write
IOException - if an I/O error occurs
public Writer append(CharSequence csq,
int start,
int end)
throws IOException
append(CharSequence, int, int) method.
append in interface Appendableappend in class Writercsq - The character sequence to writestart - The index of the first character to writeend - The index of the first character to write (exclusive)
IOException - if an I/O error occurs
public Writer append(CharSequence csq)
throws IOException
append(CharSequence) method.
append in interface Appendableappend in class Writercsq - The character sequence to write
IOException - if an I/O error occurs
public void write(int idx)
throws IOException
write(int) method.
write in class FilterWriteridx - the character to write
IOException - if an I/O error occurs
public void write(char[] chr)
throws IOException
write(char[]) method.
write in class Writerchr - the characters to write
IOException - if an I/O error occurs
public void write(char[] chr,
int st,
int len)
throws IOException
write(char[], int, int) method.
write in class FilterWriterchr - the characters to writest - The start offsetlen - The number of characters to write
IOException - if an I/O error occurs
public void write(String str)
throws IOException
write(String) method.
write in class Writerstr - the string to write
IOException - if an I/O error occurs
public void write(String str,
int st,
int len)
throws IOException
write(String) method.
write in class FilterWriterstr - the string to writest - The start offsetlen - The number of characters to write
IOException - if an I/O error occurs
public void flush()
throws IOException
flush() method.
flush in interface Flushableflush in class FilterWriterIOException - if an I/O error occurs
public void close()
throws IOException
close() method.
close in interface Closeableclose in class FilterWriterIOException - if an I/O error occurs
protected void beforeWrite(int n)
throws IOException
write(int) method, buffer
length for write(char[]), 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 chars to be written
IOException - if the pre-processing fails
protected void afterWrite(int n)
throws IOException
write(int) method, buffer length for write(char[]),
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 chars written
IOException - if the post-processing fails
protected void handleIOException(IOException e)
throws IOException
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
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||