com.google.common.io
Class CharSource

java.lang.Object
  extended by com.google.common.io.CharSource

public abstract class CharSource
extends java.lang.Object

A readable source of characters, such as a text file. Unlike a Reader, a CharSource is not an open, stateful stream of characters that can be read and closed. Instead, it is an immutable supplier of InputStream instances.

CharSource provides two kinds of methods:

Several methods in this class, such as readLines(), break the contents of the source into lines. Like BufferedReader, these methods break lines on any of \n, \r or \r\n, do not include the line separator in each line and do not consider there to be an empty line at the end if the contents are terminated with a line separator.

Any ByteSource containing text encoded with a specific character encoding may be viewed as a CharSource using ByteSource.asCharSource(Charset).

Since:
14.0

Constructor Summary
CharSource()
           
 
Method Summary
 long copyTo(java.lang.Appendable appendable)
          Appends the contents of this source to the given Appendable (such as a Writer).
 long copyTo(CharSink sink)
          Copies the contents of this source to the given sink.
 java.io.BufferedReader openBufferedStream()
          Opens a new BufferedReader for reading from this source.
abstract  java.io.Reader openStream()
          Opens a new Reader for reading from this source.
 java.lang.String read()
          Reads the contents of this source as a string.
 java.lang.String readFirstLine()
          Reads the first link of this source as a string.
 ImmutableList<java.lang.String> readLines()
          Reads all the lines of this source as a list of strings.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CharSource

public CharSource()
Method Detail

openStream

public abstract java.io.Reader openStream()
                                   throws java.io.IOException
Opens a new Reader for reading from this source. This method should return a new, independent reader each time it is called.

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

Throws:
java.io.IOException - if an I/O error occurs in the process of opening the reader

openBufferedStream

public java.io.BufferedReader openBufferedStream()
                                          throws java.io.IOException
Opens a new BufferedReader for reading from this source. This method should return a new, independent reader each time it is called.

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

Throws:
java.io.IOException - if an I/O error occurs in the process of opening the reader

copyTo

public long copyTo(java.lang.Appendable appendable)
            throws java.io.IOException
Appends the contents of this source to the given Appendable (such as a Writer). Does not close appendable if it is Closeable.

Throws:
java.io.IOException - if an I/O error occurs in the process of reading from this source or writing to appendable

copyTo

public long copyTo(CharSink sink)
            throws java.io.IOException
Copies the contents of this source to the given sink.

Throws:
java.io.IOException - if an I/O error occurs in the process of reading from this source or writing to sink

read

public java.lang.String read()
                      throws java.io.IOException
Reads the contents of this source as a string.

Throws:
java.io.IOException - if an I/O error occurs in the process of reading from this source

readFirstLine

@Nullable
public java.lang.String readFirstLine()
                               throws java.io.IOException
Reads the first link of this source as a string. Returns null if this source is empty.

Like BufferedReader, this method breaks lines on any of \n, \r or \r\n, does not include the line separator in the returned line and does not consider there to be an extra empty line at the end if the content is terminated with a line separator.

Throws:
java.io.IOException - if an I/O error occurs in the process of reading from this source

readLines

public ImmutableList<java.lang.String> readLines()
                                          throws java.io.IOException
Reads all the lines of this source as a list of strings. The returned list will be empty if this source is empty.

Like BufferedReader, this method breaks lines on any of \n, \r or \r\n, does not include the line separator in the returned lines and does not consider there to be an extra empty line at the end if the content is terminated with a line separator.

Throws:
java.io.IOException - if an I/O error occurs in the process of reading from this source