Package com.google.common.io

Class LineReader

java.lang.Object

com.google.common.io.LineReader

@Beta
@GwtIncompatible
public final class LineReader
extends Object

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

Since:

1.0

Author:

Chris Nokleberg

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	readLine()	Reads a line of text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineReader

public LineReader(Readable readable)

Creates a new instance that will read lines from the given Readable object.

Method Detail

readLine

@CanIgnoreReturnValue
@CheckForNull
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:

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.

Throws:

IOException - if an I/O error occurs