Added in API level 1

LineNumberReader

open class LineNumberReader : BufferedReader

kotlin.Any
↳	java.io.Reader
	↳	java.io.BufferedReader
		↳	java.io.LineNumberReader

A buffered character-input stream that keeps track of line numbers. This class defines methods setLineNumber(int) and getLineNumber() for setting and getting the current line number respectively.

By default, line numbering begins at 0. This number increments at every line terminator as the data is read, and can be changed with a call to setLineNumber(int). Note however, that setLineNumber(int) does not actually change the current position in the stream; it only changes the value that will be returned by getLineNumber().

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.

Summary

Public constructors
LineNumberReader(in: Reader!) Create a new line-numbering reader, using the default input-buffer size.
LineNumberReader(in: Reader!, sz: Int) Create a new line-numbering reader, reading characters into a buffer of the given size.

Public methods
open Int	getLineNumber() Get the current line number.
open Unit	mark(readAheadLimit: Int) Mark the present position in the stream.
open Int	read() Read a single character.
open Int	read(cbuf: CharArray!, off: Int, len: Int) Read characters into a portion of an array.
open String!	readLine() Read a line of text.
open Unit	reset() Reset the stream to the most recent mark.
open Unit	setLineNumber(lineNumber: Int) Set the current line number.
open Long	skip(n: Long) Skip characters.

Inherited functions
From class BufferedReader Unit close() Stream<String!>! lines() Returns a Stream, the elements of which are lines read from this BufferedReader. The Stream is lazily populated, i.e., read only occurs during the terminal stream operation. The reader must not be operated on during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined. After execution of the terminal stream operation there are no guarantees that the reader will be at a specific position from which to read the next character or line. If an IOException is thrown when accessing the underlying BufferedReader, it is wrapped in an UncheckedIOException which will be thrown from the Stream method that caused the read to take place. This method will return a Stream if invoked on a BufferedReader that is closed. Any operation on that stream that requires reading from the BufferedReader after it is closed, will cause an UncheckedIOException to be thrown. Boolean markSupported() Tells whether this stream supports the mark() operation, which it does. Boolean ready() Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.
From class Reader Reader! nullReader() Returns a new Reader that reads no characters. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect. While the stream is open, the read(), read(char[]), read(char[], int, int), read(Charbuffer), ready(), skip(long), and transferTo() methods all behave as if end of stream has been reached. After the stream has been closed, these methods all throw IOException. The markSupported() method returns false. The mark() and reset() methods throw an IOException. The object used to synchronize operations on the returned Reader is not specified. Int read(cbuf: CharArray!) Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. Int read(target: CharBuffer!) Attempts to read characters into the specified character buffer. The buffer is used as a repository of characters as-is: the only changes made are the results of a put operation. No flipping or rewinding of the buffer is performed. Long transferTo(out: Writer!) Reads all characters from this reader and writes the characters to the given writer in the order that they are read. On return, this reader will be at end of the stream. This method does not close either reader or writer. This method may block indefinitely reading from the reader, or writing to the writer. The behavior for the case where the reader and/or writer is asynchronously closed, or the thread interrupted during the transfer, is highly reader and writer specific, and therefore not specified. If an I/O error occurs reading from the reader or writing to the writer, then it may do so after some characters have been read or written. Consequently the reader may not be at end of the stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs.

Inherited properties
From class Reader Any! lock The object used to synchronize operations on this stream. For efficiency, a character-stream object may use an object other than itself to protect critical sections. A subclass should therefore use the object in this field rather than this or a synchronized method.

Public constructors

LineNumberReader

Added in API level 1

LineNumberReader(in: Reader!)

Create a new line-numbering reader, using the default input-buffer size.

Parameters
in	Reader!: A Reader object to provide the underlying stream

LineNumberReader

Added in API level 1

LineNumberReader(
    in: Reader!, 
    sz: Int)

Create a new line-numbering reader, reading characters into a buffer of the given size.

Parameters
in	Reader!: A Reader object to provide the underlying stream
sz	Int: An int specifying the size of the buffer

Public methods

getLineNumber

Added in API level 1

open fun getLineNumber(): Int

Get the current line number.

Return
Int	The current line number

See Also

• #setLineNumber

mark

Added in API level 1

open fun mark(readAheadLimit: Int): Unit

Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point, and will also reset the line number appropriately.

Parameters
readAheadLimit	Int: Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail.

Exceptions
java.io.IOException	If an I/O error occurs

read

Added in API level 1

open fun read(): Int

Read a single character. Line terminators are compressed into single newline ('\n') characters. Whenever a line terminator is read the current line number is incremented.

Return
Int	The character read, or -1 if the end of the stream has been reached

Exceptions
java.io.IOException	If an I/O error occurs

read

Added in API level 1

open fun read(
    cbuf: CharArray!, 
    off: Int, 
    len: Int
): Int

Read characters into a portion of an array. Whenever a line terminator is read the current line number is incremented.

Parameters
cbuf	CharArray!: Destination buffer
off	Int: Offset at which to start storing characters
len	Int: Maximum number of characters to read

Return
Int	The number of bytes read, or -1 if the end of the stream has already been reached

Exceptions
java.io.IOException	If an I/O error occurs
java.lang.IndexOutOfBoundsException

readLine

Added in API level 1

open fun readLine(): String!

Read a line of text. Whenever a line terminator is read the current line number is incremented.

Return
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

Exceptions
java.io.IOException	If an I/O error occurs

reset

Added in API level 1

open fun reset(): Unit

Reset the stream to the most recent mark.

Exceptions
java.io.IOException	If the stream has not been marked, or if the mark has been invalidated

setLineNumber

Added in API level 1

open fun setLineNumber(lineNumber: Int): Unit

Set the current line number.

Parameters
lineNumber	Int: An int specifying the line number

See Also

• #getLineNumber

skip

Added in API level 1

open fun skip(n: Long): Long

Skip characters.

Parameters
n	Long: The number of characters to skip

Return
Long	The number of characters actually skipped

Exceptions
java.io.IOException	If an I/O error occurs
java.lang.IllegalArgumentException	If n is negative