Class CharSink

java.lang.Object
com.google.common.io.CharSink
@GwtIncompatible public abstract class CharSink extends Object
A destination to which characters can be written, such as a text file. Unlike a Writer, a CharSink is not an open, stateful stream that can be written to and closed. Instead, it is an immutable supplier of Writer instances.

CharSink provides two kinds of methods:

  • Methods that return a writer: These methods should return a new, independent instance each time they are called. The caller is responsible for ensuring that the returned writer is closed.
  • Convenience methods: These are implementations of common operations that are typically implemented by opening a writer using one of the methods in the first category, doing something and finally closing the writer that was opened.

Any ByteSink may be viewed as a CharSink with a specific character encoding using ByteSink.asCharSink(Charset). Characters written to the resulting CharSink will written to the ByteSink as encoded bytes.

Since:
14.0
Author:
Colin Decker

  • Constructor Details

    • CharSink

      protected CharSink()
      Constructor for use by subclasses.

  • Method Details

    • openStream

      public abstract Writer openStream() throws IOException
      Opens a new Writer for writing to this sink. This method returns a new, independent writer each time it is called.

      The caller is responsible for ensuring that the returned writer is closed.

      Throws:
      IOException - if an I/O error occurs while opening the writer

    • openBufferedStream

      public Writer openBufferedStream() throws IOException
      Opens a new buffered Writer for writing to this sink. The returned stream is not required to be a BufferedWriter in order to allow implementations to simply delegate to openStream() when the stream returned by that method does not benefit from additional buffering. This method returns a new, independent writer each time it is called.

      The caller is responsible for ensuring that the returned writer is closed.

      Throws:
      IOException - if an I/O error occurs while opening the writer
      Since:
      15.0 (in 14.0 with return type BufferedWriter)

    • write

      public void write(CharSequence charSequence) throws IOException
      Writes the given character sequence to this sink.
      Throws:
      IOException - if an I/O error while writing to this sink

    • writeLines

      public void writeLines(Iterable<? extends CharSequence> lines) throws IOException
      Writes the given lines of text to this sink with each line (including the last) terminated with the operating system's default line separator. This method is equivalent to writeLines(lines, System.getProperty("line.separator")).
      Throws:
      IOException - if an I/O error occurs while writing to this sink

    • writeLines

      public void writeLines(Iterable<? extends CharSequence> lines, String lineSeparator) throws IOException
      Writes the given lines of text to this sink with each line (including the last) terminated with the given line separator.
      Throws:
      IOException - if an I/O error occurs while writing to this sink

    • writeLines

      public void writeLines(Stream<? extends CharSequence> lines) throws IOException
      Writes the given lines of text to this sink with each line (including the last) terminated with the operating system's default line separator. This method is equivalent to writeLines(lines, System.getProperty("line.separator")).
      Throws:
      IOException - if an I/O error occurs while writing to this sink
      Since:
      33.4.0 (but since 22.0 in the JRE flavor)

    • writeLines

      public void writeLines(Stream<? extends CharSequence> lines, String lineSeparator) throws IOException
      Writes the given lines of text to this sink with each line (including the last) terminated with the given line separator.
      Throws:
      IOException - if an I/O error occurs while writing to this sink
      Since:
      33.4.0 (but since 22.0 in the JRE flavor)

    • writeFrom

      @CanIgnoreReturnValue public long writeFrom(Readable readable) throws IOException
      Writes all the text from the given Readable (such as a Reader) to this sink. Does not close readable if it is Closeable.
      Returns:
      the number of characters written
      Throws:
      IOException - if an I/O error occurs while reading from readable or writing to this sink