com.asakusafw.utils.java.parser.javadoc

Interface JavadocScanner

All Known Implementing Classes:

DefaultJavadocScanner

public interface JavadocScanner

An abstract super interface of scanners which provides a sequence of JavadocToken.

Method Summary

Modifier and Type	Method and Description
void	consume(int count) Consumes the tokens.
int	getIndex() Returns the next token index.
List<JavadocToken>	getTokens() Returns the tokens.
JavadocToken	lookahead(int offset) Looks ahead the token after the offset.
JavadocToken	nextToken() Consumes the next token and returns it.
void	seek(int position) Sets the index of the current scanner position.

Method Detail

getTokens

List<JavadocToken> getTokens()

Returns the tokens.

Returns:

the tokens

consume

void consume(int count)

Consumes the tokens.

Parameters:

count - the number of tokens to be consumed

nextToken

JavadocToken nextToken()

Consumes the next token and returns it.

Returns:

the next token

lookahead

JavadocToken lookahead(int offset)

Looks ahead the token after the offset. The next token's offset is 0.

Parameters:

offset - the token offset

Returns:

the look-ahead token

getIndex

int getIndex()

Returns the next token index.

Returns:

the next token index

seek

void seek(int position)

Sets the index of the current scanner position.

Parameters:

position - the index which indicates the next token