Guava: Google Core Libraries for Java 32.1.2-jre · com.google.common.io.CharSink

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.

Access	Constructor and Description
protected	CharSink() Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
public Writer	openBufferedStream() Opens a new buffered `Writer` for writing to this sink.
public abstract Writer	openStream() Opens a new `Writer` for writing to this sink.
public void	write(CharSequence charSequence) Writes the given character sequence to this sink.
public long	Returns: the number of characters written writeFrom(Readable readable) Writes all the text from the given `Readable` (such as a `Reader`) to this sink.
public void	writeLines(Iterable<? extends CharSequence> lines) Writes the given lines of text to this sink with each line (including the last) terminated with the operating system's default line separator.
public void	writeLines(Iterable<? extends CharSequence> lines, String lineSeparator) Writes the given lines of text to this sink with each line (including the last) terminated with the given line separator.
public void	writeLines(Stream<? extends CharSequence> lines) Writes the given lines of text to this sink with each line (including the last) terminated with the operating system's default line separator.
public void	writeLines(Stream<? extends CharSequence> lines, String lineSeparator) Writes the given lines of text to this sink with each line (including the last) terminated with the given line separator.
private void	writeLines(Iterator<? extends CharSequence> lines, String lineSeparator)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

CharSink	back to summary
protected CharSink() Constructor for use by subclasses.

Method Detail

openBufferedStream back to summary

openBufferedStream	back to summary
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. Exceptions IOException: if an I/O error occurs while opening the writer Since 15.0 (in 14.0 with return type `BufferedWriter`)

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.

Exceptions

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

Since

15.0 (in 14.0 with return type BufferedWriter)

openStream back to summary

openStream	back to summary
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. Exceptions IOException: if an I/O error occurs while opening the writer

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.

Exceptions

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

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

write

back to summary

public void write(CharSequence charSequence) throws IOException

Writes the given character sequence to this sink.

Exceptions

IOException:: if an I/O error while writing to this sink

writeFrom back to summary

writeFrom	back to summary
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:long the number of characters written Annotations @CanIgnoreReturnValue Exceptions IOException: if an I/O error occurs while reading from `readable` or writing to this sink

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:long

the number of characters written

Annotations

@CanIgnoreReturnValue

Exceptions

IOException:: if an I/O error occurs while reading from readable or writing to this sink

writeLines back to summary

writeLines	back to summary
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"))`. Exceptions IOException: if an I/O error occurs while writing to this sink

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")).

Exceptions

IOException:: if an I/O error occurs while writing to this sink

writeLines	back to summary
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. Exceptions IOException: if an I/O error occurs while writing to this sink

writeLines

back to summary

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.

Exceptions

IOException:: if an I/O error occurs while writing to this sink

writeLines back to summary

writeLines	back to summary
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"))`. Exceptions IOException: if an I/O error occurs while writing to this sink Since 22.0

public void writeLines(Stream<? extends CharSequence> lines) throws IOException

Exceptions

IOException:: if an I/O error occurs while writing to this sink

Since

22.0

writeLines	back to summary
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. Exceptions IOException: if an I/O error occurs while writing to this sink Since 22.0

writeLines

back to summary

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.

Exceptions

IOException:: if an I/O error occurs while writing to this sink

Since

22.0

writeLines	back to summary
private void writeLines(Iterator<? extends CharSequence> lines, String lineSeparator) throws IOException

public abstract Class CharSink

Constructor Summary

Method Summary

Constructor Detail

Method Detail