Class FilterWriter

  • All Implemented Interfaces:
    Closeable, Flushable, Appendable, AutoCloseable


    public abstract class FilterWriter
    extends Writer
    Abstract class for writing filtered character streams. The abstract class FilterWriter itself provides default methods that pass all requests to the contained stream. Subclasses of FilterWriter should override some of these methods and may also provide additional methods and fields.
    Since:
    JDK1.1
    • Field Summary

      Fields

      Modifier and Type Field and Description
      protected Writer out
      The underlying character-output stream.
    • Constructor Summary

      Constructors

      Modifier Constructor and Description
      protected FilterWriter(Writer out)
      Create a new filtered writer.
    • Field Detail

      • out

        protected Writer out
        The underlying character-output stream.
    • Constructor Detail

      • FilterWriter

        protected FilterWriter(Writer out)
        Create a new filtered writer.
        Parameters:
        out - a Writer object to provide the underlying stream.
        Throws:
        NullPointerException - if out is null
    • Method Detail

      • write

        public void write(int c)
                   throws IOException
        Writes a single character.
        Overrides:
        write in class  Writer
        Parameters:
        c - int specifying a character to be written
        Throws:
        IOException - If an I/O error occurs
      • write

        public void write(char[] cbuf,
                          int off,
                          int len)
                   throws IOException
        Writes a portion of an array of characters.
        Specified by:
        write in class  Writer
        Parameters:
        cbuf - Buffer of characters to be written
        off - Offset from which to start reading characters
        len - Number of characters to be written
        Throws:
        IOException - If an I/O error occurs
      • write

        public void write(String str,
                          int off,
                          int len)
                   throws IOException
        Writes a portion of a string.
        Overrides:
        write in class  Writer
        Parameters:
        str - String to be written
        off - Offset from which to start reading characters
        len - Number of characters to be written
        Throws:
        IOException - If an I/O error occurs
      • close

        public void close()
                   throws IOException
        Description copied from class: Writer
        Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.
        Specified by:
        close in interface  Closeable
        Specified by:
        close in interface  AutoCloseable
        Specified by:
        close in class  Writer
        Throws:
        IOException - If an I/O error occurs