Package groovy.io

Class LineColumnReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable
    public class LineColumnReader
extends java.io.BufferedReader
    The LineColumnReader is an extension to BufferedReader that keeps track of the line and column information of where the cursor is.
    Since:
    1.8.0

    • Field Summary

      • Fields inherited from class java.io.Reader

        lock

    • Constructor Summary

      Constructors 
      Constructor Description
      LineColumnReader​(java.io.Reader reader)
      Constructor wrapping a Reader (FileReader, FileReader, InputStreamReader, etc.)

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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)
      Reads characters into an array.
      int read​(char[] chars, int startOffset, int length)
      Reads characters into a portion of an array.
      int read​(java.nio.CharBuffer buffer)
      Not implemented.
      java.lang.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.

      • Methods inherited from class java.io.BufferedReader

        lines, markSupported, ready

      • Methods inherited from class java.io.Reader

        nullReader, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LineColumnReader

        public LineColumnReader​(java.io.Reader reader)
        Constructor wrapping a Reader (FileReader, FileReader, InputStreamReader, etc.)
        Parameters:
        reader - the reader to wrap

    • Method Detail

      • mark

        public void mark​(int readAheadLimit)
          throws java.io.IOException
        Marks the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
        Overrides:
        mark in class java.io.BufferedReader
        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.
        Throws:
        java.io.IOException

      • reset

        public void reset()
           throws java.io.IOException
        Resets the stream to the most recent mark.
        Overrides:
        reset in class java.io.BufferedReader
        Throws:
        java.io.IOException

      • read

        public int read()
         throws java.io.IOException
        Reads a single character.
        Overrides:
        read in class java.io.BufferedReader
        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
        Throws:
        java.io.IOException

      • read

        public int read​(char[] chars,
                int startOffset,
                int length)
         throws java.io.IOException
        Reads characters into a portion of an array.
        Overrides:
        read in class java.io.BufferedReader
        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
        Throws:
        java.io.IOException

      • readLine

        public java.lang.String readLine()
                          throws java.io.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.
        Overrides:
        readLine in class java.io.BufferedReader
        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:
        java.io.IOException

      • skip

        public long skip​(long toSkip)
          throws java.io.IOException
        Skips characters.
        Overrides:
        skip in class java.io.BufferedReader
        Parameters:
        toSkip - the number of characters to skip
        Returns:
        The number of characters actually skipped
        Throws:
        java.io.IOException

      • read

        public int read​(char[] chars)
         throws java.io.IOException
        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.
        Overrides:
        read in class java.io.Reader
        Parameters:
        chars - Destination buffer
        Returns:
        The number of characters read, or -1 if the end of the stream has been reached
        Throws:
        java.io.IOException

      • read

        public int read​(java.nio.CharBuffer buffer)
        Not implemented.
        Specified by:
        read in interface java.lang.Readable
        Overrides:
        read in class java.io.Reader
        Parameters:
        buffer - Destination buffer
        Returns:
        The number of characters read, or -1 if the end of the stream has been reached
        Throws:
        java.lang.UnsupportedOperationException - as the method is not implemented

      • close

        public void close()
           throws java.io.IOException
        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.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.BufferedReader
        Throws:
        java.io.IOException

      • getColumn

        public long getColumn()

      • setColumn

        public void setColumn​(long column)

      • getColumnMark

        public long getColumnMark()

      • setColumnMark

        public void setColumnMark​(long columnMark)

      • getLine

        public long getLine()

      • setLine

        public void setLine​(long line)

      • getLineMark

        public long getLineMark()

      • setLineMark

        public void setLineMark​(long lineMark)