Package: groovy.io

## [Java] Class LineColumnReader

- groovy.io.LineColumnReader

- The `LineColumnReader` is an extension to `BufferedReader` that keeps track of the line and column information of where the cursor is.

  Authors:
    Guillaume Laforge
  Since:
    1.8.0

- - ### Properties Summary

    Properties
    Type | Name and description
    --- | ---
    `long` | `column`
    `long` | `columnMark`
    `long` | `line`
    `long` | `lineMark`

  - ### Constructor Summary

    Constructors
    Constructor and description
    `LineColumnReader (Reader reader)` Constructor wrapping a `Reader` (`FileReader`, `FileReader`, `InputStreamReader`, etc.)

  - ### Methods Summary

    Methods
    Type Params | Return Type | Name and description
    --- | --- | ---
    `` | `void` | `close()` Closes the stream and releases any system resources associated with it.
    `` | `long` | `getColumn()`
    `` | `long` | `getColumnMark()`
    `` | `long` | `getLine()`
    `` | `long` | `getLineMark()`
    `` | `void` | `mark(int readAheadLimit)` Marks the present position in the stream.
    `` | `int` | `read()` Reads a single character.
    `` | `int` | `read(char[] chars, int startOffset, int length)` Reads characters into a portion of an array.
    `` | `int` | `read(char[] chars)` Reads characters into an array.
    `` | `int` | `read(CharBuffer buffer)` Not implemented.
    `` | `String` | `readLine()` Reads a line of text.
    `` | `void` | `reset()` Resets the stream to the most recent mark.
    `` | `void` | `setColumn(long column)`
    `` | `void` | `setColumnMark(long columnMark)`
    `` | `void` | `setLine(long line)`
    `` | `void` | `setLineMark(long lineMark)`
    `` | `long` | `skip(long toSkip)` Skips characters.

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class BufferedReader` | `read, read, close, readLine, mark, markSupported, reset, skip, lines, ready, read, read, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`
    `class Reader` | `read, read, read, read, close, mark, markSupported, reset, skip, ready, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Property Detail

    - #### long column

    - #### long columnMark

    - #### long line

    - #### long lineMark

  - ### Constructor Detail

    - #### public LineColumnReader(Reader reader)

      Constructor wrapping a `Reader` (`FileReader`, `FileReader`, `InputStreamReader`, etc.)

      Parameters:
        `reader` - the reader to wrap

  - ### Method Detail

    - #### @Override public void close()

      Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

    - #### public long getColumn()

    - #### public long getColumnMark()

    - #### public long getLine()

    - #### public long getLineMark()

    - #### @Override public void mark(int readAheadLimit)

      Marks the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.

      Parameters:
        `readAheadLimit` - Limit on the number of characters that may be read while still preserving the mark. An attempt to reset the stream after reading characters up to this limit or beyond may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care.

    - #### @Override public int read()

      Reads a single character.

      Returns:
        The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

    - #### @Override public int read(char[] chars, int startOffset, int length)

      Reads characters into a portion of an array.

      Parameters:
        `chars` - Destination array of char
        `startOffset` - Offset at which to start storing characters
        `length` - Maximum number of characters to read
      Returns:
        an exception if an error occurs

    - #### @Override public int read(char[] chars)

      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.

      Parameters:
        `chars` - Destination buffer
      Returns:
        The number of characters read, or -1 if the end of the stream has been reached

    - #### @Override public int read(CharBuffer buffer)

      Not implemented.

      throws:
        UnsupportedOperationException as the method is not implemented
      Parameters:
        `buffer` - Destination buffer
      Returns:
        The number of characters read, or -1 if the end of the stream has been reached

    - #### @Override public String readLine()

      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.

      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

    - #### @Override public void reset()

      Resets the stream to the most recent mark.

    - #### public void setColumn(long column)

    - #### public void setColumnMark(long columnMark)

    - #### public void setLine(long line)

    - #### public void setLineMark(long lineMark)

    - #### @Override public long skip(long toSkip)

      Skips characters.

      Parameters:
        `toSkip` - the number of characters to skip
      Returns:
        The number of characters actually skipped