net.sourceforge.pmd.lang.ast

Interface GenericToken

public interface GenericToken

Represents a language-independent token such as constants, values language reserved keywords, or comments.

Method Summary

Modifier and Type	Method and Description
int	getBeginColumn() Gets the column offset from the start of the begin line where the token's region begins
int	getBeginLine() Gets the line where the token's region begins
int	getEndColumn() Gets the column offset from the start of the end line where the token's region ends
int	getEndLine() Gets the line where the token's region ends
java.lang.String	getImage() Gets the token's text.
GenericToken	getNext() Obtain the next generic token according to the input stream which generated the instance of this token.
GenericToken	getPreviousComment() Obtain a comment-type token which, according to the input stream which generated the instance of this token, precedes this instance token and succeeds the previous generic token (if there is any).

Method Detail

getNext

GenericToken getNext()

Obtain the next generic token according to the input stream which generated the instance of this token.

Returns:

the next generic token if it exists; null if it does not exist

getPreviousComment

GenericToken getPreviousComment()

Obtain a comment-type token which, according to the input stream which generated the instance of this token, precedes this instance token and succeeds the previous generic token (if there is any).

Returns:

the comment-type token if it exists; null if it does not exist

getImage

java.lang.String getImage()

Gets the token's text.

Returns:

the token's text

getBeginLine

int getBeginLine()

Gets the line where the token's region begins

Returns:

a non-negative integer containing the begin line

getEndLine

int getEndLine()

Gets the line where the token's region ends

Returns:

a non-negative integer containing the end line

getBeginColumn

int getBeginColumn()

Gets the column offset from the start of the begin line where the token's region begins

Returns:

a non-negative integer containing the begin column

getEndColumn

int getEndColumn()

Gets the column offset from the start of the end line where the token's region ends

Returns:

a non-negative integer containing the begin column