com.asakusafw.utils.java.parser.javadoc

Class DefaultJavadocTokenStream

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.DefaultJavadocTokenStream

All Implemented Interfaces:

JavadocTokenStream

public class DefaultJavadocTokenStream
extends Object
implements JavadocTokenStream

A basic implementation of JavadocTokenStream.

Constructor Summary

Constructors

Constructor and Description
DefaultJavadocTokenStream(JavadocScanner scanner) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	discard() Discards the last marked position.
JavadocToken	lookahead(int k) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultJavadocTokenStream

public DefaultJavadocTokenStream(JavadocScanner scanner)

Creates a new instance.

Parameters:

scanner - the element scanner

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

peek

public JavadocToken peek()

Description copied from interface: JavadocTokenStream

Returns the next token.

Specified by:

peek in interface JavadocTokenStream

Returns:

the next token

lookahead

public JavadocToken lookahead(int k)

Description copied from interface: JavadocTokenStream

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

Specified by:

lookahead in interface JavadocTokenStream

Parameters:

k - the token offset

Returns:

the look-ahead token

nextToken

public JavadocToken nextToken()

Description copied from interface: JavadocTokenStream

Consumes the next token and returns it.

Specified by:

nextToken in interface JavadocTokenStream

Returns:

the next token

mark

public void mark()

Description copied from interface: JavadocTokenStream

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

Specified by:

mark in interface JavadocTokenStream

rewind

public void rewind()

Description copied from interface: JavadocTokenStream

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

Specified by:

rewind in interface JavadocTokenStream

discard

public void discard()

Description copied from interface: JavadocTokenStream

Discards the last marked position.

Specified by:

discard in interface JavadocTokenStream