com.sun.tools.javac.parser
Interface Lexer

All Known Implementing Classes:

DocCommentScanner, Scanner

public interface Lexer

The lexical analyzer maps an input stream consisting of ASCII characters and Unicode escapes into a token sequence.

This is NOT part of any API supported by Sun Microsystems. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Method Summary

boolean	deprecatedFlag() Has a @deprecated been encountered in last doc comment? This needs to be reset by client with resetDeprecatedFlag.
java.lang.String	docComment() Returns the documentation string of the current token.
int	endPos() Return the last character position of the current token.
int	errPos() Return the position where a lexical error occurred;
void	errPos(int pos) Set the position where a lexical error occurred;
Position.LineMap	getLineMap() Build a map for translating between line numbers and positions in the input.
char[]	getRawCharacters() Returns a copy of the input buffer, up to its inputLength.
char[]	getRawCharacters(int beginIndex, int endIndex) Returns a copy of a character array subset of the input buffer.
Name	name() Return the name of an identifier or token for the current token.
void	nextToken() Read token.
int	pos() Return the current token's position: a 0-based offset from beginning of the raw input stream (before unicode translation)
int	prevEndPos() Return the last character position of the previous token.
int	radix() Return the radix of a numeric literal token.
void	resetDeprecatedFlag()
java.lang.String	stringVal() The value of a literal token, recorded as a string.
Token	token() Return the current token, set by nextToken().
void	token(Token token) Sets the current token.

Method Detail

deprecatedFlag

boolean deprecatedFlag()

Has a @deprecated been encountered in last doc comment? This needs to be reset by client with resetDeprecatedFlag.

resetDeprecatedFlag

void resetDeprecatedFlag()

docComment

java.lang.String docComment()

Returns the documentation string of the current token.

endPos

int endPos()

Return the last character position of the current token.

errPos

int errPos()

Return the position where a lexical error occurred;

errPos

void errPos(int pos)

Set the position where a lexical error occurred;

getLineMap

Position.LineMap getLineMap()

Build a map for translating between line numbers and positions in the input.

Returns:

a LineMap

getRawCharacters

char[] getRawCharacters()

Returns a copy of the input buffer, up to its inputLength. Unicode escape sequences are not translated.

getRawCharacters

char[] getRawCharacters(int beginIndex,
                        int endIndex)

Returns a copy of a character array subset of the input buffer. The returned array begins at the beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex. This behavior is like String.substring(beginIndex, endIndex). Unicode escape sequences are not translated.

Parameters:

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

Throws:

IndexOutOfBounds - if either offset is outside of the array bounds

name

Name name()

Return the name of an identifier or token for the current token.

nextToken

void nextToken()

Read token.

pos

int pos()

Return the current token's position: a 0-based offset from beginning of the raw input stream (before unicode translation)

prevEndPos

int prevEndPos()

Return the last character position of the previous token.

radix

int radix()

Return the radix of a numeric literal token.

stringVal

java.lang.String stringVal()

The value of a literal token, recorded as a string. For integers, leading 0x and 'l' suffixes are suppressed.

token

Token token()

Return the current token, set by nextToken().

token

void token(Token token)

Sets the current token.