Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.io.LineReader

A class for reading lines of text. Provides the same functionality as java.io.BufferedReader#readLine() but for all Readable objects, not just instances of Reader.

Field Summary

Modifier and Type	Field and Description
private final char[]	buf
private final CharBuffer	cbuf
private final LineBuffer	lineBuf
private final Queue<String>	lines
private final Readable	readable
private final Reader	reader

Constructor Summary

Access	Constructor and Description
public	LineReader(Readable readable) Creates a new instance that will read lines from the given `Readable` object.

Method Summary

Modifier and Type	Method and Description
public String	Returns: a `String` containing the contents of the line, not including any line-termination characters, or `null` if the end of the stream has been reached. readLine() Reads a line of text.

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

Field Detail

buf	back to summary
private final char[] buf

cbuf	back to summary
private final CharBuffer cbuf

lineBuf	back to summary
private final LineBuffer lineBuf

lines	back to summary
private final Queue<String> lines

readable	back to summary
private final Readable readable

reader	back to summary
private final Reader reader Annotations @CheckForNull

Constructor Detail

LineReader	back to summary
public LineReader(Readable readable) Creates a new instance that will read lines from the given `Readable` object.

Method Detail

readLine back to summary

readLine	back to summary
public String readLine() throws IOException Reads a line of text. A line is considered to be terminated by any one of a line feed (`'\n'`), a carriage return (`'\r'`), or a carriage return followed immediately by a linefeed (`"\r\n"`). Returns:String a `String` containing the contents of the line, not including any line-termination characters, or `null` if the end of the stream has been reached. Annotations @CanIgnoreReturnValue @CheckForNull Exceptions IOException: if an I/O error occurs

public String readLine() throws IOException

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed ("\r\n").

Returns:String

a String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached.

Annotations

@CanIgnoreReturnValue
@CheckForNull

Exceptions

IOException:: if an I/O error occurs