Class LineAndColumnTracker
java.lang.Object
org.codehaus.commons.compiler.util.LineAndColumnTracker
Keeps track of "line numbers" and "column numbers" while a char stream is being processed. Line breaks are
identified as defined by the
\R
pattern of Pattern
. Initially, line number and column number are 1.
This class has no public constructors, instead, use one of the static "factory methods".
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
consume
(char c) Consumes the next character of the stream.static LineAndColumnTracker
create()
abstract int
Returns the column number of the previously consumed character; 1 after a line separator character has been consumed, 2 after the first non-line-separator character, and so forth.abstract int
Returns the line number of the previously consumed character (starting at 1).abstract void
reset()
Resets the current line number to 1 and the current column number to one.abstract void
setColumnNumber
(int columnNumber) Sets the "current column number" to the given value.abstract void
setLineNumber
(int lineNumber) Sets the "current line number" to the given value.abstract void
setTabWidth
(int tabWidth) Reconfigures the TAB width.
-
Field Details
-
DEFAULT_TAB_WIDTH
public static final int DEFAULT_TAB_WIDTHThe default "tab width".- See Also:
-
-
Constructor Details
-
LineAndColumnTracker
public LineAndColumnTracker()
-
-
Method Details
-
setTabWidth
public abstract void setTabWidth(int tabWidth) Reconfigures the TAB width. Value1
will treat TAB characters just like any other (non-line-break) character. The default tab with isDEFAULT_TAB_WIDTH
(8). -
consume
public abstract void consume(char c) Consumes the next character of the stream. -
getLineNumber
public abstract int getLineNumber()Returns the line number of the previously consumed character (starting at 1). Line separator characters belong to the "next" line. -
setLineNumber
public abstract void setLineNumber(int lineNumber) Sets the "current line number" to the given value. -
getColumnNumber
public abstract int getColumnNumber()Returns the column number of the previously consumed character; 1 after a line separator character has been consumed, 2 after the first non-line-separator character, and so forth. -
setColumnNumber
public abstract void setColumnNumber(int columnNumber) Sets the "current column number" to the given value. -
reset
public abstract void reset()Resets the current line number to 1 and the current column number to one. (The configuredtab width
remains.) -
create
- Returns:
- A
LineAndColumnTracker
instance
-