org.apache.commons.io.output

Class ProxyWriter

  • All Implemented Interfaces:
    Closeable, Flushable, Appendable, AutoCloseable
    Direct Known Subclasses:
    CloseShieldWriter, TaggedWriter

    public class ProxyWriter
    extends FilterWriter
    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).
    • Constructor Summary

      Constructors  
      Constructor and Description
      ProxyWriter(Writer proxy)
      Constructs a new ProxyWriter.
    • Constructor Detail

      • ProxyWriter

        public ProxyWriter(Writer proxy)
        Constructs a new ProxyWriter.
        Parameters:
        proxy - the Writer to delegate to
    • Method Detail

      • append

        public Writer append(char c)
                      throws IOException
        Invokes the delegate's append(char) method.
        Specified by:
        append in interface  Appendable
        Overrides:
        append in class  Writer
        Parameters:
        c - The character to write
        Returns:
        this writer
        Throws:
        IOException - if an I/O error occurs.
        Since:
        2.0
      • append

        public Writer append(CharSequence csq,
                             int start,
                             int end)
                      throws IOException
        Invokes the delegate's append(CharSequence, int, int) method.
        Specified by:
        append in interface  Appendable
        Overrides:
        append in class  Writer
        Parameters:
        csq - The character sequence to write
        start - The index of the first character to write
        end - The index of the first character to write (exclusive)
        Returns:
        this writer
        Throws:
        IOException - if an I/O error occurs.
        Since:
        2.0
      • write

        public void write(int c)
                   throws IOException
        Invokes the delegate's write(int) method.
        Overrides:
        write in class  FilterWriter
        Parameters:
        c - the character to write
        Throws:
        IOException - if an I/O error occurs.
      • write

        public void write(char[] cbuf)
                   throws IOException
        Invokes the delegate's write(char[]) method.
        Overrides:
        write in class  Writer
        Parameters:
        cbuf - the characters to write
        Throws:
        IOException - if an I/O error occurs.
      • write

        public void write(char[] cbuf,
                          int off,
                          int len)
                   throws IOException
        Invokes the delegate's write(char[], int, int) method.
        Overrides:
        write in class  FilterWriter
        Parameters:
        cbuf - the characters to write
        off - The start offset
        len - The number of characters to write
        Throws:
        IOException - if an I/O error occurs.
      • write

        public void write(String str)
                   throws IOException
        Invokes the delegate's write(String) method.
        Overrides:
        write in class  Writer
        Parameters:
        str - the string to write
        Throws:
        IOException - if an I/O error occurs.
      • write

        public void write(String str,
                          int off,
                          int len)
                   throws IOException
        Invokes the delegate's write(String) method.
        Overrides:
        write in class  FilterWriter
        Parameters:
        str - the string to write
        off - The start offset
        len - The number of characters to write
        Throws:
        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 chars to be written (1 for the 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.

        Parameters:
        n - number of chars to be written
        Throws:
        IOException - if the pre-processing fails
        Since:
        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 chars written (1 for the 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.

        Parameters:
        n - number of chars written
        Throws:
        IOException - if the post-processing fails
        Since:
        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 behavior is to re-throw the exception.

        Parameters:
        e - The IOException thrown
        Throws:
        IOException - if an I/O error occurs.
        Since:
        2.0

Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.