Package com.google.common.io
Class CharSink
- java.lang.Object
-
- com.google.common.io.CharSink
-
@GwtIncompatible public abstract class CharSink extends java.lang.Object
A destination to which characters can be written, such as a text file. Unlike aWriter
, aCharSink
is not an open, stateful stream that can be written to and closed. Instead, it is an immutable supplier ofWriter
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 aCharSink
with a specific character encoding usingByteSink.asCharSink(Charset)
. Characters written to the resultingCharSink
will written to theByteSink
as encoded bytes.- Since:
- 14.0
- Author:
- Colin Decker
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CharSink()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.io.Writer
openBufferedStream()
Opens a new bufferedWriter
for writing to this sink.abstract java.io.Writer
openStream()
Opens a newWriter
for writing to this sink.void
write(java.lang.CharSequence charSequence)
Writes the given character sequence to this sink.long
writeFrom(java.lang.Readable readable)
Writes all the text from the givenReadable
(such as aReader
) to this sink.void
writeLines(java.lang.Iterable<? extends java.lang.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.void
writeLines(java.lang.Iterable<? extends java.lang.CharSequence> lines, java.lang.String lineSeparator)
Writes the given lines of text to this sink with each line (including the last) terminated with the given line separator.
-
-
-
Constructor Detail
-
CharSink
protected CharSink()
Constructor for use by subclasses.
-
-
Method Detail
-
openStream
public abstract java.io.Writer openStream() throws java.io.IOException
Opens a newWriter
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:
java.io.IOException
- if an I/O error occurs while opening the writer
-
openBufferedStream
public java.io.Writer openBufferedStream() throws java.io.IOException
Opens a new bufferedWriter
for writing to this sink. The returned stream is not required to be aBufferedWriter
in order to allow implementations to simply delegate toopenStream()
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:
java.io.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(java.lang.CharSequence charSequence) throws java.io.IOException
Writes the given character sequence to this sink.- Throws:
java.io.IOException
- if an I/O error while writing to this sink
-
writeLines
public void writeLines(java.lang.Iterable<? extends java.lang.CharSequence> lines) throws java.io.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 towriteLines(lines, System.getProperty("line.separator"))
.- Throws:
java.io.IOException
- if an I/O error occurs while writing to this sink
-
writeLines
public void writeLines(java.lang.Iterable<? extends java.lang.CharSequence> lines, java.lang.String lineSeparator) throws java.io.IOException
Writes the given lines of text to this sink with each line (including the last) terminated with the given line separator.- Throws:
java.io.IOException
- if an I/O error occurs while writing to this sink
-
writeFrom
@CanIgnoreReturnValue public long writeFrom(java.lang.Readable readable) throws java.io.IOException
Writes all the text from the givenReadable
(such as aReader
) to this sink. Does not closereadable
if it isCloseable
.- Returns:
- the number of characters written
- Throws:
java.io.IOException
- if an I/O error occurs while reading fromreadable
or writing to this sink
-
-