Home » openjdk-7 » java » io » [javadoc | source]
java.io
public class: LineNumberReader [javadoc | source]
java.lang.Object
   java.io.Reader
      java.io.BufferedReader
         java.io.LineNumberReader

All Implemented Interfaces:
    Closeable, Readable

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.

Fields inherited from java.io.Reader:
lock
Constructor:
 public LineNumberReader(Reader in) 
    Create a new line-numbering reader, using the default input-buffer size.
    Parameters:
    in - A Reader object to provide the underlying stream
 public LineNumberReader(Reader in,
    int sz) 
    Create a new line-numbering reader, reading characters into a buffer of the given size.
    Parameters:
    in - A Reader object to provide the underlying stream
    sz - An int specifying the size of the buffer
Method from java.io.LineNumberReader Summary:
getLineNumber,   mark,   read,   read,   readLine,   reset,   setLineNumber,   skip
Methods from java.io.BufferedReader:
close,   mark,   markSupported,   read,   read,   readLine,   readLine,   ready,   reset,   skip
Methods from java.io.Reader:
close,   mark,   markSupported,   read,   read,   read,   read,   ready,   reset,   skip
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.LineNumberReader Detail:
 public int getLineNumber() 
    Get the current line number.
 public  void mark(int readAheadLimit) throws IOException 
    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.
 public int read() throws IOException 
    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.
 public int read(char[] cbuf,
    int off,
    int len) throws IOException 
    Read characters into a portion of an array. Whenever a line terminator is read the current line number is incremented.
 public String readLine() throws IOException 
    Read a line of text. Whenever a line terminator is read the current line number is incremented.
 public  void reset() throws IOException 
    Reset the stream to the most recent mark.
 public  void setLineNumber(int lineNumber) 
    Set the current line number.
 public long skip(long n) throws IOException 
    Skip characters.