Package java.io

Class FilterWriter

java.lang.Object
java.io.Writer
java.io.FilterWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable, AutoCloseable
public abstract class FilterWriter
extends Writer
Wraps an existing Writer and performs some transformation on the output data while it is being written. Transformations can be anything from a simple byte-wise filtering output data to an on-the-fly compression or decompression of the underlying writer. Writers that wrap another writer and provide some additional functionality on top of it usually inherit from this class.
See Also:
FilterReader

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected Writer out
    The Writer being filtered.

    Fields inherited from class java.io.Writer

    lock

  • Constructor Summary

    Constructors
    Modifier Constructor Description
    protected FilterWriter​(Writer out)
    Constructs a new FilterWriter on the Writer out.

  • Method Summary

    Modifier and Type Method Description
    void close()
    Closes this writer.
    void flush()
    Flushes this writer to ensure all pending data is sent out to the target writer.
    void write​(char[] buffer, int offset, int count)
    Writes count characters from the char array buffer starting at position offset to the target writer.
    void write​(int oneChar)
    Writes the specified character oneChar to the target writer.
    void write​(String str, int offset, int count)
    Writes count characters from the string str starting at position index to this writer.

    Methods inherited from class java.io.Writer

    append, append, append, write, write

    Methods inherited from class java.lang.Object

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

  • Field Details

    • out

      protected Writer out
      The Writer being filtered.

  • Constructor Details

    • FilterWriter

      protected FilterWriter​(Writer out)
      Constructs a new FilterWriter on the Writer out. All writes are now filtered through this writer.
      Parameters:
      out - the target Writer to filter writes on.

  • Method Details

    • close

      public void close() throws IOException
      Closes this writer. This implementation closes the target writer.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Writer
      Throws:
      IOException - if an error occurs attempting to close this writer.

    • flush

      public void flush() throws IOException
      Flushes this writer to ensure all pending data is sent out to the target writer. This implementation flushes the target writer.
      Specified by:
      flush in interface Flushable
      Specified by:
      flush in class Writer
      Throws:
      IOException - if an error occurs attempting to flush this writer.

    • write

      public void write​(char[] buffer, int offset, int count) throws IOException
      Writes count characters from the char array buffer starting at position offset to the target writer.
      Specified by:
      write in class Writer
      Parameters:
      buffer - the buffer to write.
      offset - the index of the first character in buffer to write.
      count - the number of characters in buffer to write.
      Throws:
      IOException - if an error occurs while writing to this writer.

    • write

      public void write​(int oneChar) throws IOException
      Writes the specified character oneChar to the target writer. Only the two least significant bytes of the integer oneChar are written.
      Overrides:
      write in class Writer
      Parameters:
      oneChar - the char to write to the target writer.
      Throws:
      IOException - if an error occurs while writing to this writer.

    • write

      public void write​(String str, int offset, int count) throws IOException
      Writes count characters from the string str starting at position index to this writer. This implementation writes str to the target writer.
      Overrides:
      write in class Writer
      Parameters:
      str - the string to be written.
      offset - the index of the first character in str to write.
      count - the number of chars in str to write.
      Throws:
      IOException - if an error occurs while writing to this writer.