Modifier and Type	Class and Description
private class	CharSource.AsByteSource A byte source that reads chars from this source and encodes them as bytes using a charset.
private static class	CharSource.CharSequenceCharSource
private static class	CharSource.ConcatenatedCharSource
private static class	CharSource.EmptyCharSource
private static class	CharSource.StringCharSource Subclass specialized for string instances.

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

Method Summary

Modifier and Type	Method and Description
public ByteSource	asByteSource(Charset charset) Returns a `ByteSource` view of this char source that encodes chars read from this source as bytes using the given `Charset`.
public static CharSource	Returns: a `CharSource` containing the concatenated data concat(Iterable<? extends CharSource> the sources to concatenate sources) Concatenates multiple `CharSource` instances into a single source.
public static CharSource	Returns: a `CharSource` containing the concatenated data concat(Iterator<? extends CharSource> the sources to concatenate sources) Concatenates multiple `CharSource` instances into a single source.
public static CharSource	Returns: a `CharSource` containing the concatenated data concat(CharSource... the sources to concatenate sources) Concatenates multiple `CharSource` instances into a single source.
public long	Returns: the number of characters copied copyTo(Appendable appendable) Appends the contents of this source to the given `Appendable` (such as a `Writer`).
public long	Returns: the number of characters copied copyTo(CharSink sink) Copies the contents of this source to the given sink.
private long	countBySkipping(Reader reader)
public static CharSource	empty() Returns an immutable `CharSource` that contains no characters.
public void	forEachLine(Consumer<? super String> action) Reads all lines of text from this source, running the given `action` for each line as it is read.
public boolean	isEmpty() Returns whether the source has zero chars.
public long	length() Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream.
public Optional<Long>	lengthIfKnown() Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream.
public Stream<String>	lines() Opens a new `Stream` for reading text one line at a time from this source.
public BufferedReader	openBufferedStream() Opens a new `BufferedReader` for reading from this source.
public abstract Reader	openStream() Opens a new `Reader` for reading from this source.
public String	read() Reads the contents of this source as a string.
public String	readFirstLine() Reads the first line of this source as a string.
public ImmutableList<String>	readLines() Reads all the lines of this source as a list of strings.
public <T extends @Nullable Object> T	readLines(LineProcessor<T> processor) Reads lines of text from this source, processing each line as it is read using the given `processor`.
public static CharSource	wrap(CharSequence charSequence) Returns a view of the given character sequence as a `CharSource`.

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

Constructor Detail

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

Method Detail

asByteSource back to summary

asByteSource	back to summary
public ByteSource asByteSource(Charset charset) Returns a `ByteSource` view of this char source that encodes chars read from this source as bytes using the given `Charset`. If `ByteSource#asCharSource` is called on the returned source with the same charset, the default implementation of this method will ensure that the original `CharSource` is returned, rather than round-trip encoding. Subclasses that override this method should behave the same way. Since 20.0

public ByteSource asByteSource(Charset charset)

Returns a ByteSource view of this char source that encodes chars read from this source as bytes using the given Charset.

If ByteSource#asCharSource is called on the returned source with the same charset, the default implementation of this method will ensure that the original CharSource is returned, rather than round-trip encoding. Subclasses that override this method should behave the same way.

Since: 20.0

concat back to summary

concat	back to summary
public static CharSource concat(Iterable<? extends CharSource> sources) Concatenates multiple `CharSource` instances into a single source. Streams returned from the source will contain the concatenated data from the streams of the underlying sources. Only one underlying stream will be open at a time. Closing the concatenated stream will close the open underlying stream. Parameters sources:Iterable<? extends CharSource> the sources to concatenate Returns:CharSource a `CharSource` containing the concatenated data Since 15.0

public static CharSource concat(Iterable<? extends CharSource> sources)

Concatenates multiple CharSource instances into a single source. Streams returned from the source will contain the concatenated data from the streams of the underlying sources.

Only one underlying stream will be open at a time. Closing the concatenated stream will close the open underlying stream.

Parameters

sources:Iterable<? extends CharSource>: the sources to concatenate

Returns:CharSource

a CharSource containing the concatenated data

Since

15.0

concat back to summary

concat	back to summary
public static CharSource concat(Iterator<? extends CharSource> sources) Concatenates multiple `CharSource` instances into a single source. Streams returned from the source will contain the concatenated data from the streams of the underlying sources. Only one underlying stream will be open at a time. Closing the concatenated stream will close the open underlying stream. Note The input `Iterator` will be copied to an `ImmutableList` when this method is called. This will fail if the iterator is infinite and may cause problems if the iterator eagerly fetches data for each source when iterated (rather than producing sources that only load data through their streams). Prefer using the `concat(Iterable)` overload if possible. Parameters sources:Iterator<? extends CharSource> the sources to concatenate Returns:CharSource a `CharSource` containing the concatenated data Exceptions NullPointerException: if any of `sources` is `null` Since 15.0

public static CharSource concat(Iterator<? extends CharSource> sources)

Concatenates multiple CharSource instances into a single source. Streams returned from the source will contain the concatenated data from the streams of the underlying sources.

Only one underlying stream will be open at a time. Closing the concatenated stream will close the open underlying stream.

Note

The input Iterator will be copied to an ImmutableList when this method is called. This will fail if the iterator is infinite and may cause problems if the iterator eagerly fetches data for each source when iterated (rather than producing sources that only load data through their streams). Prefer using the concat(Iterable) overload if possible.

Parameters

sources:Iterator<? extends CharSource>: the sources to concatenate

Returns:CharSource

a CharSource containing the concatenated data

Exceptions

NullPointerException:: if any of sources is null

Since

15.0

concat back to summary

concat	back to summary
public static CharSource concat(CharSource... sources) Concatenates multiple `CharSource` instances into a single source. Streams returned from the source will contain the concatenated data from the streams of the underlying sources. Only one underlying stream will be open at a time. Closing the concatenated stream will close the open underlying stream. Parameters sources:CharSource[] the sources to concatenate Returns:CharSource a `CharSource` containing the concatenated data Exceptions NullPointerException: if any of `sources` is `null` Since 15.0

public static CharSource concat(CharSource... sources)

Concatenates multiple CharSource instances into a single source. Streams returned from the source will contain the concatenated data from the streams of the underlying sources.

Only one underlying stream will be open at a time. Closing the concatenated stream will close the open underlying stream.

Parameters

sources:CharSource[]: the sources to concatenate

Returns:CharSource

a CharSource containing the concatenated data

Exceptions

NullPointerException:: if any of sources is null

Since

15.0

copyTo back to summary

copyTo	back to summary
public long copyTo(Appendable appendable) throws IOException Appends the contents of this source to the given `Appendable` (such as a `Writer`). Does not close `appendable` if it is `Closeable`. Returns:long the number of characters copied Annotations @CanIgnoreReturnValue Exceptions IOException: if an I/O error occurs while reading from this source or writing to `appendable`

public long copyTo(Appendable appendable) throws IOException

Appends the contents of this source to the given Appendable (such as a Writer). Does not close appendable if it is Closeable.

Returns:long

the number of characters copied

Annotations

@CanIgnoreReturnValue

Exceptions

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

copyTo back to summary

copyTo	back to summary
public long copyTo(CharSink sink) throws IOException Copies the contents of this source to the given sink. Returns:long the number of characters copied Annotations @CanIgnoreReturnValue Exceptions IOException: if an I/O error occurs while reading from this source or writing to `sink`

public long copyTo(CharSink sink) throws IOException

Copies the contents of this source to the given sink.

Returns:long

the number of characters copied

Annotations

@CanIgnoreReturnValue

Exceptions

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

countBySkipping	back to summary
private long countBySkipping(Reader reader) throws IOException

empty back to summary

empty	back to summary
public static CharSource empty() Returns an immutable `CharSource` that contains no characters. Since 15.0

public static CharSource empty()

Returns an immutable CharSource that contains no characters.

Since: 15.0

forEachLine back to summary

forEachLine	back to summary
public void forEachLine(Consumer<? super String> action) throws IOException Reads all lines of text from this source, running the given `action` for each line as it is read. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Exceptions IOException: if an I/O error occurs while reading from this source or if `action` throws an `UncheckedIOException` Since 22.0

public void forEachLine(Consumer<? super String> action) throws IOException

Reads all lines of text from this source, running the given action for each line as it is read.

Like BufferedReader#readLine(), this method considers a line to be a sequence of text that is terminated by (but does not include) one of \r\n, \r or \n. If the source's content does not end in a line termination sequence, it is treated as if it does.

Exceptions

IOException:: if an I/O error occurs while reading from this source or if action throws an UncheckedIOException

Since

22.0

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() throws IOException Returns whether the source has zero chars. The default implementation first checks `lengthIfKnown`, returning true if it's known to be zero and false if it's known to be non-zero. If the length is not known, it falls back to opening a stream and checking for EOF. Note that, in cases where `lengthIfKnown` returns zero, it is possible that chars are actually available for reading. This means that a source may return `true` from `isEmpty()` despite having readable content. Exceptions IOException: if an I/O error occurs Since 15.0

public boolean isEmpty() throws IOException

Returns whether the source has zero chars. The default implementation first checks lengthIfKnown, returning true if it's known to be zero and false if it's known to be non-zero. If the length is not known, it falls back to opening a stream and checking for EOF.

Note that, in cases where lengthIfKnown returns zero, it is possible that chars are actually available for reading. This means that a source may return true from isEmpty() despite having readable content.

Exceptions

IOException:: if an I/O error occurs

Since

15.0

length back to summary

length	back to summary
public long length() throws IOException Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream. To avoid a potentially expensive operation, see `lengthIfKnown`. The default implementation calls `lengthIfKnown` and returns the value if present. If absent, it will fall back to a heavyweight operation that will open a stream, `skip` to the end of the stream, and return the total number of chars that were skipped. Note that for sources that implement `lengthIfKnown` to provide a more efficient implementation, it is possible that this method will return a different number of chars than would be returned by reading all of the chars. In either case, for mutable sources such as files, a subsequent read may return a different number of chars if the contents are changed. Exceptions IOException: if an I/O error occurs while reading the length of this source Since 19.0

public long length() throws IOException

Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream. To avoid a potentially expensive operation, see lengthIfKnown.

The default implementation calls lengthIfKnown and returns the value if present. If absent, it will fall back to a heavyweight operation that will open a stream, skip to the end of the stream, and return the total number of chars that were skipped.

Note that for sources that implement lengthIfKnown to provide a more efficient implementation, it is possible that this method will return a different number of chars than would be returned by reading all of the chars.

In either case, for mutable sources such as files, a subsequent read may return a different number of chars if the contents are changed.

Exceptions

IOException:: if an I/O error occurs while reading the length of this source

Since

19.0

lengthIfKnown back to summary

lengthIfKnown	back to summary
public Optional<Long> lengthIfKnown() Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream. The default implementation returns `Optional#absent`. Some sources, such as a `CharSequence`, may return a non-absent value. Note that in such cases, it is possible that this method will return a different number of chars than would be returned by reading all of the chars. Additionally, for mutable sources such as `StringBuilder`s, a subsequent read may return a different number of chars if the contents are changed. Since 19.0

public Optional<Long> lengthIfKnown()

Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream.

The default implementation returns Optional#absent. Some sources, such as a CharSequence, may return a non-absent value. Note that in such cases, it is possible that this method will return a different number of chars than would be returned by reading all of the chars.

Additionally, for mutable sources such as StringBuilders, a subsequent read may return a different number of chars if the contents are changed.

Since: 19.0

lines back to summary

lines	back to summary
public Stream<String> lines() throws IOException Opens a new `Stream` for reading text one line at a time from this source. This method returns a new, independent stream each time it is called. The returned stream is lazy and only reads from the source in the terminal operation. If an I/O error occurs while the stream is reading from the source or when the stream is closed, an `UncheckedIOException` is thrown. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. The caller is responsible for ensuring that the returned stream is closed. For example: `try (Stream<String> lines = source.lines()) { lines.map(...) .filter(...) .forEach(...); }` Annotations @MustBeClosed Exceptions IOException: if an I/O error occurs while opening the stream Since 22.0

public Stream<String> lines() throws IOException

Opens a new Stream for reading text one line at a time from this source. This method returns a new, independent stream each time it is called.

The returned stream is lazy and only reads from the source in the terminal operation. If an I/O error occurs while the stream is reading from the source or when the stream is closed, an UncheckedIOException is thrown.

The caller is responsible for ensuring that the returned stream is closed. For example:

try (Stream<String> lines = source.lines()) {
  lines.map(...)
     .filter(...)
     .forEach(...);
}

Annotations

@MustBeClosed

Exceptions

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

Since

22.0

openBufferedStream back to summary

openBufferedStream	back to summary
public BufferedReader openBufferedStream() throws IOException Opens a new `BufferedReader` for reading from this source. This method returns a new, independent reader each time it is called. The caller is responsible for ensuring that the returned reader is closed. Exceptions IOException: if an I/O error occurs while of opening the reader

public BufferedReader openBufferedStream() throws IOException

Opens a new BufferedReader for reading from this source. This method returns a new, independent reader each time it is called.

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

Exceptions

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

openStream back to summary

openStream	back to summary
public abstract Reader openStream() throws IOException Opens a new `Reader` for reading from this source. This method returns a new, independent reader each time it is called. The caller is responsible for ensuring that the returned reader is closed. Exceptions IOException: if an I/O error occurs while opening the reader

public abstract Reader openStream() throws IOException

Opens a new Reader for reading from this source. This method returns a new, independent reader each time it is called.

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

Exceptions

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

read	back to summary
public String read() throws IOException Reads the contents of this source as a string. Exceptions IOException: if an I/O error occurs while reading from this source

read

back to summary

public String read() throws IOException

Reads the contents of this source as a string.

Exceptions

IOException:: if an I/O error occurs while reading from this source

readFirstLine back to summary

readFirstLine	back to summary
public String readFirstLine() throws IOException Reads the first line of this source as a string. Returns `null` if this source is empty. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Annotations @CheckForNull Exceptions IOException: if an I/O error occurs while reading from this source

public String readFirstLine() throws IOException

Reads the first line of this source as a string. Returns null if this source is empty.

Annotations

@CheckForNull

Exceptions

IOException:: if an I/O error occurs while reading from this source

readLines back to summary

readLines	back to summary
public ImmutableList<String> readLines() throws 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#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Exceptions IOException: if an I/O error occurs while reading from this source

public ImmutableList<String> readLines() throws IOException

Reads all the lines of this source as a list of strings. The returned list will be empty if this source is empty.

Exceptions

IOException:: if an I/O error occurs while reading from this source

readLines back to summary

readLines	back to summary
public <T extends @Nullable Object> T readLines(LineProcessor<T> processor) throws IOException Reads lines of text from this source, processing each line as it is read using the given `processor`. Stops when all lines have been processed or the processor returns `false` and returns the result produced by the processor. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Annotations @CanIgnoreReturnValue @ParametricNullness Exceptions IOException: if an I/O error occurs while reading from this source or if `processor` throws an `IOException` Since 16.0

public <T extends @Nullable Object> T readLines(LineProcessor<T> processor) throws IOException

Reads lines of text from this source, processing each line as it is read using the given processor. Stops when all lines have been processed or the processor returns false and returns the result produced by the processor.

Annotations

@CanIgnoreReturnValue
@ParametricNullness

Exceptions

IOException:: if an I/O error occurs while reading from this source or if processor throws an IOException

Since

16.0

wrap back to summary

wrap	back to summary
public static CharSource wrap(CharSequence charSequence) Returns a view of the given character sequence as a `CharSource`. The behavior of the returned `CharSource` and any `Reader` instances created by it is unspecified if the `charSequence` is mutated while it is being read, so don't do that. Since 15.0 (since 14.0 as `CharStreams.asCharSource(String)`)

public static CharSource wrap(CharSequence charSequence)

Returns a view of the given character sequence as a CharSource. The behavior of the returned CharSource and any Reader instances created by it is unspecified if the charSequence is mutated while it is being read, so don't do that.

Since: 15.0 (since 14.0 as CharStreams.asCharSource(String))

com.google.common.io back to summary

private final Class CharSource.AsByteSource

Class Inheritance

extends ByteSource

java.lang.Object
com.google.common.io.ByteSource
com.google.common.io.CharSource.AsByteSource

A byte source that reads chars from this source and encodes them as bytes using a charset.

Field Summary

Modifier and Type	Field and Description
pack-priv final Charset	charset

Constructor Summary

Access	Constructor and Description
pack-priv	AsByteSource(Charset charset)

Method Summary

Modifier and Type	Method and Description
public CharSource	asCharSource(Charset charset) Overrides com.google.common.io.ByteSource.asCharSource. Returns a `CharSource` view of this byte source that decodes bytes read from this source as characters using the given `Charset`.
public InputStream	openStream() Implements abstract com.google.common.io.ByteSource.openStream. Opens a new `InputStream` for reading from this source.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.google.common.io.ByteSource:: concat concat concat contentEquals copyTo copyTo empty hash isEmpty openBufferedStream read read size sizeIfKnown slice wrap

Field Detail

charset	back to summary
pack-priv final Charset charset

Constructor Detail

AsByteSource	back to summary
pack-priv AsByteSource(Charset charset)

Method Detail

asCharSource back to summary

asCharSource	back to summary
public CharSource asCharSource(Charset charset) Overrides com.google.common.io.ByteSource.asCharSource. Doc from com.google.common.io.ByteSource.asCharSource. Returns a `CharSource` view of this byte source that decodes bytes read from this source as characters using the given `Charset`. If `CharSource#asByteSource` is called on the returned source with the same charset, the default implementation of this method will ensure that the original `ByteSource` is returned, rather than round-trip encoding. Subclasses that override this method should behave the same way. Annotations @Override

public CharSource asCharSource(Charset charset)

Overrides com.google.common.io.ByteSource.asCharSource.

Doc from com.google.common.io.ByteSource.asCharSource.

Returns a CharSource view of this byte source that decodes bytes read from this source as characters using the given Charset.

If CharSource#asByteSource is called on the returned source with the same charset, the default implementation of this method will ensure that the original ByteSource is returned, rather than round-trip encoding. Subclasses that override this method should behave the same way.

Annotations

@Override

openStream back to summary

openStream	back to summary
public InputStream openStream() throws IOException Implements abstract com.google.common.io.ByteSource.openStream. Doc from com.google.common.io.ByteSource.openStream. Opens a new `InputStream` for reading from this source. This method returns a new, independent stream each time it is called. The caller is responsible for ensuring that the returned stream is closed. Annotations @Override Exceptions IOException: if an I/O error occurs while opening the stream

public InputStream openStream() throws IOException

Implements abstract com.google.common.io.ByteSource.openStream.

Doc from com.google.common.io.ByteSource.openStream.

Opens a new InputStream for reading from this source. This method returns a new, independent stream each time it is called.

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

Annotations

@Override

Exceptions

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

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.io back to summary

private Class CharSource.CharSequenceCharSource

Class Inheritance

extends CharSource

java.lang.Object
com.google.common.io.CharSource
com.google.common.io.CharSource.CharSequenceCharSource

Known Direct Subclasses

com.google.common.io.CharSource.StringCharSource

Field Summary

Modifier and Type	Field and Description
private static final Splitter	LINE_SPLITTER
protected final CharSequence	seq

Constructor Summary

Access	Constructor and Description
protected	CharSequenceCharSource(CharSequence seq)

Method Summary

Modifier and Type	Method and Description
public boolean	isEmpty() Overrides com.google.common.io.CharSource.isEmpty. Returns whether the source has zero chars.
public long	length() Overrides com.google.common.io.CharSource.length. Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream.
public Optional<Long>	lengthIfKnown() Overrides com.google.common.io.CharSource.lengthIfKnown. Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream.
public Stream<String>	lines() Overrides com.google.common.io.CharSource.lines. Opens a new `Stream` for reading text one line at a time from this source.
private Iterator<String>	linesIterator() Returns an iterator over the lines in the string.
public Reader	openStream() Implements abstract com.google.common.io.CharSource.openStream. Opens a new `Reader` for reading from this source.
public String	read() Overrides com.google.common.io.CharSource.read. Reads the contents of this source as a string.
public String	readFirstLine() Overrides com.google.common.io.CharSource.readFirstLine. Reads the first line of this source as a string.
public ImmutableList<String>	readLines() Overrides com.google.common.io.CharSource.readLines. Reads all the lines of this source as a list of strings.
public <T extends @Nullable Object> T	readLines(LineProcessor<T> processor) Overrides com.google.common.io.CharSource.readLines. Reads lines of text from this source, processing each line as it is read using the given `processor`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.google.common.io.CharSource:: asByteSource concat concat concat copyTo copyTo empty forEachLine openBufferedStream wrap

Field Detail

LINE_SPLITTER	back to summary
private static final Splitter LINE_SPLITTER

seq	back to summary
protected final CharSequence seq

Constructor Detail

CharSequenceCharSource	back to summary
protected CharSequenceCharSource(CharSequence seq)

Method Detail

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides com.google.common.io.CharSource.isEmpty. Doc from com.google.common.io.CharSource.isEmpty. Returns whether the source has zero chars. The default implementation first checks `lengthIfKnown`, returning true if it's known to be zero and false if it's known to be non-zero. If the length is not known, it falls back to opening a stream and checking for EOF. Note that, in cases where `lengthIfKnown` returns zero, it is possible that chars are actually available for reading. This means that a source may return `true` from `isEmpty()` despite having readable content. Annotations @Override

public boolean isEmpty()

Overrides com.google.common.io.CharSource.isEmpty.

Doc from com.google.common.io.CharSource.isEmpty.

Annotations

@Override

length back to summary

length	back to summary
public long length() Overrides com.google.common.io.CharSource.length. Doc from com.google.common.io.CharSource.length. Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream. To avoid a potentially expensive operation, see `lengthIfKnown`. The default implementation calls `lengthIfKnown` and returns the value if present. If absent, it will fall back to a heavyweight operation that will open a stream, `skip` to the end of the stream, and return the total number of chars that were skipped. Note that for sources that implement `lengthIfKnown` to provide a more efficient implementation, it is possible that this method will return a different number of chars than would be returned by reading all of the chars. In either case, for mutable sources such as files, a subsequent read may return a different number of chars if the contents are changed. Annotations @Override

public long length()

Overrides com.google.common.io.CharSource.length.

Doc from com.google.common.io.CharSource.length.

Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream. To avoid a potentially expensive operation, see lengthIfKnown.

In either case, for mutable sources such as files, a subsequent read may return a different number of chars if the contents are changed.

Annotations

@Override

lengthIfKnown back to summary

lengthIfKnown	back to summary
public Optional<Long> lengthIfKnown() Overrides com.google.common.io.CharSource.lengthIfKnown. Doc from com.google.common.io.CharSource.lengthIfKnown. Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream. The default implementation returns `Optional#absent`. Some sources, such as a `CharSequence`, may return a non-absent value. Note that in such cases, it is possible that this method will return a different number of chars than would be returned by reading all of the chars. Additionally, for mutable sources such as `StringBuilder`s, a subsequent read may return a different number of chars if the contents are changed. Annotations @Override

public Optional<Long> lengthIfKnown()

Overrides com.google.common.io.CharSource.lengthIfKnown.

Doc from com.google.common.io.CharSource.lengthIfKnown.

Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream.

Additionally, for mutable sources such as StringBuilders, a subsequent read may return a different number of chars if the contents are changed.

Annotations

@Override

lines back to summary

lines	back to summary
public Stream<String> lines() Overrides com.google.common.io.CharSource.lines. Doc from com.google.common.io.CharSource.lines. Opens a new `Stream` for reading text one line at a time from this source. This method returns a new, independent stream each time it is called. The returned stream is lazy and only reads from the source in the terminal operation. If an I/O error occurs while the stream is reading from the source or when the stream is closed, an `UncheckedIOException` is thrown. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. The caller is responsible for ensuring that the returned stream is closed. For example: `try (Stream<String> lines = source.lines()) { lines.map(...) .filter(...) .forEach(...); }` Annotations @Override

public Stream<String> lines()

Overrides com.google.common.io.CharSource.lines.

Doc from com.google.common.io.CharSource.lines.

Opens a new Stream for reading text one line at a time from this source. This method returns a new, independent stream each time it is called.

The caller is responsible for ensuring that the returned stream is closed. For example:

try (Stream<String> lines = source.lines()) {
  lines.map(...)
     .filter(...)
     .forEach(...);
}

Annotations

@Override

linesIterator	back to summary
private Iterator<String> linesIterator() Returns an iterator over the lines in the string. If the string ends in a newline, a final empty string is not included, to match the behavior of BufferedReader/LineReader.readLine().

openStream back to summary

openStream	back to summary
public Reader openStream() Implements abstract com.google.common.io.CharSource.openStream. Doc from com.google.common.io.CharSource.openStream. Opens a new `Reader` for reading from this source. This method returns a new, independent reader each time it is called. The caller is responsible for ensuring that the returned reader is closed. Annotations @Override

public Reader openStream()

Implements abstract com.google.common.io.CharSource.openStream.

Doc from com.google.common.io.CharSource.openStream.

Opens a new Reader for reading from this source. This method returns a new, independent reader each time it is called.

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

Annotations

@Override

read	back to summary
public String read() Overrides com.google.common.io.CharSource.read. Doc from com.google.common.io.CharSource.read. Reads the contents of this source as a string. Annotations @Override

read

back to summary

public String read()

Overrides com.google.common.io.CharSource.read.

Doc from com.google.common.io.CharSource.read.

Reads the contents of this source as a string.

Annotations

@Override

readFirstLine back to summary

readFirstLine	back to summary
public String readFirstLine() Overrides com.google.common.io.CharSource.readFirstLine. Doc from com.google.common.io.CharSource.readFirstLine. Reads the first line of this source as a string. Returns `null` if this source is empty. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Annotations @Override @CheckForNull

public String readFirstLine()

Overrides com.google.common.io.CharSource.readFirstLine.

Doc from com.google.common.io.CharSource.readFirstLine.

Reads the first line of this source as a string. Returns null if this source is empty.

Annotations

@Override
@CheckForNull

readLines back to summary

readLines	back to summary
public ImmutableList<String> readLines() Overrides com.google.common.io.CharSource.readLines. Doc from com.google.common.io.CharSource.readLines. 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#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Annotations @Override

public ImmutableList<String> readLines()

Overrides com.google.common.io.CharSource.readLines.

Doc from com.google.common.io.CharSource.readLines.

Reads all the lines of this source as a list of strings. The returned list will be empty if this source is empty.

Annotations

@Override

readLines back to summary

readLines	back to summary
public <T extends @Nullable Object> T readLines(LineProcessor<T> processor) throws IOException Overrides com.google.common.io.CharSource.readLines. Doc from com.google.common.io.CharSource.readLines. Reads lines of text from this source, processing each line as it is read using the given `processor`. Stops when all lines have been processed or the processor returns `false` and returns the result produced by the processor. Like `BufferedReader#readLine()`, this method considers a line to be a sequence of text that is terminated by (but does not include) one of `\r\n`, `\r` or `\n`. If the source's content does not end in a line termination sequence, it is treated as if it does. Annotations @Override @ParametricNullness Exceptions IOException: if an I/O error occurs while reading from this source or if `processor` throws an `IOException`

public <T extends @Nullable Object> T readLines(LineProcessor<T> processor) throws IOException

Overrides com.google.common.io.CharSource.readLines.

Doc from com.google.common.io.CharSource.readLines.

Annotations

@Override
@ParametricNullness

Exceptions

IOException:: if an I/O error occurs while reading from this source or if processor throws an IOException

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.io back to summary

private final Class CharSource.ConcatenatedCharSource

Class Inheritance

extends CharSource

java.lang.Object
com.google.common.io.CharSource
com.google.common.io.CharSource.ConcatenatedCharSource

Field Summary

Modifier and Type	Field and Description
private final Iterable<? extends CharSource>	sources

Constructor Summary

Access	Constructor and Description
pack-priv	ConcatenatedCharSource(Iterable<? extends CharSource> sources)

Method Summary

Modifier and Type	Method and Description
public boolean	isEmpty() Overrides com.google.common.io.CharSource.isEmpty. Returns whether the source has zero chars.
public long	length() Overrides com.google.common.io.CharSource.length. Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream.
public Optional<Long>	lengthIfKnown() Overrides com.google.common.io.CharSource.lengthIfKnown. Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream.
public Reader	openStream() Implements abstract com.google.common.io.CharSource.openStream. Opens a new `Reader` for reading from this source.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.google.common.io.CharSource:: asByteSource concat concat concat copyTo copyTo empty forEachLine lines openBufferedStream read readFirstLine readLines readLines wrap

Field Detail

sources	back to summary
private final Iterable<? extends CharSource> sources

Constructor Detail

ConcatenatedCharSource	back to summary
pack-priv ConcatenatedCharSource(Iterable<? extends CharSource> sources)

Method Detail

isEmpty back to summary

public boolean isEmpty() throws IOException

Overrides com.google.common.io.CharSource.isEmpty.

Doc from com.google.common.io.CharSource.isEmpty.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

length back to summary

public long length() throws IOException

Overrides com.google.common.io.CharSource.length.

Doc from com.google.common.io.CharSource.length.

Returns the length of this source in chars, even if doing so requires opening and traversing an entire stream. To avoid a potentially expensive operation, see lengthIfKnown.

In either case, for mutable sources such as files, a subsequent read may return a different number of chars if the contents are changed.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs while reading the length of this source

lengthIfKnown back to summary

public Optional<Long> lengthIfKnown()

Overrides com.google.common.io.CharSource.lengthIfKnown.

Doc from com.google.common.io.CharSource.lengthIfKnown.

Returns the size of this source in chars, if the size can be easily determined without actually opening the data stream.

Additionally, for mutable sources such as StringBuilders, a subsequent read may return a different number of chars if the contents are changed.

Annotations

@Override

openStream back to summary

public Reader openStream() throws IOException

Implements abstract com.google.common.io.CharSource.openStream.

Doc from com.google.common.io.CharSource.openStream.

Opens a new Reader for reading from this source. This method returns a new, independent reader each time it is called.

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

Annotations

@Override

Exceptions

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

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.io back to summary

private final Class CharSource.EmptyCharSource

Class Inheritance

extends StringCharSource

java.lang.Object
com.google.common.io.CharSource
com.google.common.io.CharSource.CharSequenceCharSource
com.google.common.io.CharSource.StringCharSource
com.google.common.io.CharSource.EmptyCharSource

Field Summary

Modifier and Type	Field and Description
private static final CharSource.EmptyCharSource	INSTANCE

Constructor Summary

Access	Constructor and Description
private	EmptyCharSource()

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides com.google.common.io.CharSource.CharSequenceCharSource.toString. Returns a string representation of the object.

Inherited from com.google.common.io.CharSource.StringCharSource:: copyTo copyTo openStream

Field Detail

INSTANCE	back to summary
private static final CharSource.EmptyCharSource INSTANCE

Constructor Detail

EmptyCharSource	back to summary
private EmptyCharSource()

Method Detail

toString

back to summary

public String toString()

Overrides com.google.common.io.CharSource.CharSequenceCharSource.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.io back to summary

private Class CharSource.StringCharSource

Class Inheritance

extends CharSequenceCharSource

java.lang.Object
com.google.common.io.CharSource
com.google.common.io.CharSource.CharSequenceCharSource
com.google.common.io.CharSource.StringCharSource

Known Direct Subclasses

com.google.common.io.CharSource.EmptyCharSource

Subclass specialized for string instances.

Since Strings are immutable and built into the jdk we can optimize some operations

use StringReader instead of CharSequenceReader. It is faster since it can use String#getChars(int, int, char[], int) instead of copying characters one by one with CharSequence#charAt(int).
use Appendable#append(CharSequence) in copyTo(Appendable) and copyTo(CharSink). We know this is correct since strings are immutable and so the length can't change, and it is faster because many writers and appendables are optimized for appending string instances.

Field Summary

Inherited from com.google.common.io.CharSource.CharSequenceCharSource:: seq

Constructor Summary

Access	Constructor and Description
protected	StringCharSource(String seq)

Method Summary

Modifier and Type	Method and Description
public long	copyTo(Appendable appendable) Overrides com.google.common.io.CharSource.copyTo. Appends the contents of this source to the given `Appendable` (such as a `Writer`).
public long	copyTo(CharSink sink) Overrides com.google.common.io.CharSource.copyTo. Copies the contents of this source to the given sink.
public Reader	openStream() Overrides com.google.common.io.CharSource.CharSequenceCharSource.openStream. Opens a new `Reader` for reading from this source.

Inherited from com.google.common.io.CharSource.CharSequenceCharSource:: isEmpty length lengthIfKnown lines read readFirstLine readLines readLines toString

Constructor Detail

StringCharSource	back to summary
protected StringCharSource(String seq)

Method Detail

copyTo back to summary

public long copyTo(Appendable appendable) throws IOException

Overrides com.google.common.io.CharSource.copyTo.

Doc from com.google.common.io.CharSource.copyTo.

Appends the contents of this source to the given Appendable (such as a Writer). Does not close appendable if it is Closeable.

Returns:long

the number of characters copied

Annotations

@Override

Exceptions

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

copyTo back to summary

public long copyTo(CharSink sink) throws IOException

Overrides com.google.common.io.CharSource.copyTo.

Doc from com.google.common.io.CharSource.copyTo.

Copies the contents of this source to the given sink.

Returns:long

the number of characters copied

Annotations

@Override

Exceptions

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

openStream back to summary

public Reader openStream()

Overrides com.google.common.io.CharSource.CharSequenceCharSource.openStream.

Doc from com.google.common.io.CharSource.openStream.

Opens a new Reader for reading from this source. This method returns a new, independent reader each time it is called.

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

Annotations

@Override

public abstract Class CharSource

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class CharSource.AsByteSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CharSource.CharSequenceCharSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CharSource.ConcatenatedCharSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CharSource.EmptyCharSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CharSource.StringCharSource

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail