com.asakusafw.utils.java.parser.javadoc

Interface JavadocTokenStream

All Known Implementing Classes:

DefaultJavadocTokenStream

public interface JavadocTokenStream

Provides a stream of JavadocTokens.

See Also:

JavadocScanner

Method Summary

Modifier and Type	Method and Description
void	discard() Discards the last marked position.
JavadocToken	lookahead(int offset) Looks ahead the token after the offset.
void	mark() Marks the current stream position.
JavadocToken	nextToken() Consumes the next token and returns it.
JavadocToken	peek() Returns the next token.
void	rewind() Restores the stream position to the last marked, and discards the last marked position.

Method Detail

nextToken

JavadocToken nextToken()

Consumes the next token and returns it.

Returns:

the next token

peek

JavadocToken peek()

Returns the next token.

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

mark

void mark()

Marks the current stream position. A latter rewind() invocation will restore the position.

rewind

void rewind()

Restores the stream position to the last marked, and discards the last marked position.

Throws:

IllegalStateException - if the mark() has not been invoked, or the mark was already discarded

discard

void discard()

Discards the last marked position.

Throws:

IllegalStateException - if the mark() has not been invoked, or the mark was already discarded