|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.common.io.CharSink
public abstract class 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:
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.
Constructor Summary | |
---|---|
CharSink()
|
Method Summary | |
---|---|
java.io.BufferedWriter |
openBufferedStream()
Opens a new BufferedWriter for writing to this sink. |
abstract java.io.Writer |
openStream()
Opens a new Writer 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 given Readable (such as a Reader ) 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CharSink()
Method Detail |
---|
public abstract java.io.Writer openStream() throws java.io.IOException
Writer
for writing to this sink. This method should return a new,
independent writer each time it is called.
The caller is responsible for ensuring that the returned writer is closed.
java.io.IOException
- if an I/O error occurs in the process of opening the writerpublic java.io.BufferedWriter openBufferedStream() throws java.io.IOException
BufferedWriter
for writing to this sink. This method should return a new,
independent writer each time it is called.
The caller is responsible for ensuring that the returned writer is closed.
java.io.IOException
- if an I/O error occurs in the process of opening the writerpublic void write(java.lang.CharSequence charSequence) throws java.io.IOException
java.io.IOException
- if an I/O error in the process of writing to this sinkpublic void writeLines(java.lang.Iterable<? extends java.lang.CharSequence> lines) throws java.io.IOException
writeLines(lines, System.getProperty("line.separator"))
.
java.io.IOException
- if an I/O error occurs in the process of writing to this sinkpublic void writeLines(java.lang.Iterable<? extends java.lang.CharSequence> lines, java.lang.String lineSeparator) throws java.io.IOException
java.io.IOException
- if an I/O error occurs in the process of writing to this sinkpublic long writeFrom(java.lang.Readable readable) throws java.io.IOException
Readable
(such as a Reader
) to this sink.
Does not close readable
if it is Closeable
.
java.io.IOException
- if an I/O error occurs in the process of reading from readable
or
writing to this sink
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |