Module java.base
Package java.io

Class FilterWriter

java.lang.Object
java.io.Writer
java.io.FilterWriter
All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
public abstract classFilterWriterextendsWriter
Abstract class for writing filtered character streams. The abstract classFilterWriter itself provides default methods that pass all requests to the contained stream. Subclasses ofFilterWriter should override some of these methods and may also provide additional methods and fields.
Since:
1.1

  • Field Details

    • out

      protected Writer out
      The underlying character-output stream.

  • Constructor Details

    • FilterWriter

      protected FilterWriter(Writer out)
      Create a new filtered writer.
      Parameters:
      out - a Writer object to provide the underlying stream.
      Throws:
      NullPointerException - ifout isnull

  • Method Details

    • write

      public void write(int c) throwsIOException
      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) throwsIOException
      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:
      IndexOutOfBoundsException - If the values of theoff andlen parameters cause the corresponding method of the underlyingWriter to throw anIndexOutOfBoundsException
      IOException - If an I/O error occurs

    • write

      public void write(String str, int off, int len) throwsIOException
      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:
      IndexOutOfBoundsException - If the values of theoff andlen parameters cause the corresponding method of the underlyingWriter to throw anIndexOutOfBoundsException
      IOException - If an I/O error occurs

    • flush

      public void flush() throwsIOException
      Flushes the stream.
      Specified by:
      flush in interface Flushable
      Specified by:
      flush in class Writer
      Throws:
      IOException - If an I/O error occurs

    • close

      public void close() throwsIOException
      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 AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Writer
      Throws:
      IOException - If an I/O error occurs