commons-compiler 3.1.12 · 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".

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT_TAB_WIDTH The default "tab width".

Constructor Summary

Access	Constructor and Description
public	LineAndColumnTracker()

Method Summary

Modifier and Type	Method and Description
public abstract void	consume(char c) Consumes the next character of the stream.
public static LineAndColumnTracker	Returns: A `LineAndColumnTracker` instance create()
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.
public abstract int	getLineNumber() Returns the line number of the previously consumed character (starting at 1).
public abstract void	reset() Resets the current line number to 1 and the current column number to one.
public abstract void	setColumnNumber(int columnNumber) Sets the "current column number" to the given value.
public abstract void	setLineNumber(int lineNumber) Sets the "current line number" to the given value.
public abstract void	setTabWidth(int tabWidth) Reconfigures the TAB width.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_TAB_WIDTH back to summary

DEFAULT_TAB_WIDTH	back to summary
public static final int DEFAULT_TAB_WIDTH The default "tab width". See Also `setTabWidth(int)`

public static final int DEFAULT_TAB_WIDTH

The default "tab width".

See Also: setTabWidth(int)

Constructor Detail

LineAndColumnTracker	back to summary
public LineAndColumnTracker()

Method Detail

consume	back to summary
public abstract void consume(char c) Consumes the next character of the stream.

create	back to summary
public static LineAndColumnTracker create() Returns:LineAndColumnTracker A `LineAndColumnTracker` instance

getColumnNumber	back to summary
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.

getLineNumber	back to summary
public abstract int getLineNumber() Returns the line number of the previously consumed character (starting at 1). Line separator characters belong to the "next" line.

reset	back to summary
public abstract void reset() Resets the current line number to 1 and the current column number to one. (The configured `tab width` remains.)

setColumnNumber	back to summary
public abstract void setColumnNumber(int columnNumber) Sets the "current column number" to the given value.

setLineNumber	back to summary
public abstract void setLineNumber(int lineNumber) Sets the "current line number" to the given value.

setTabWidth	back to summary
public abstract void setTabWidth(int tabWidth) Reconfigures the TAB width. Value `1` will treat TAB characters just like any other (non-line-break) character. The default tab with is `DEFAULT_TAB_WIDTH` (8).