com.asakusafw.utils.java.parser.javadoc

Class DefaultJavadocScanner

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.DefaultJavadocScanner

All Implemented Interfaces:

JavadocScanner

public class DefaultJavadocScanner
extends Object
implements JavadocScanner

A basic implementation of JavadocScanner.

Constructor Summary

Constructors

Constructor and Description
DefaultJavadocScanner(List<JavadocToken> tokens, int successorStartsAt) Creates a new instance.

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.
static DefaultJavadocScanner	newInstance(String text) Creates a new instance from the documentation comment string.
JavadocToken	nextToken() Consumes the next token and returns it.
void	seek(int position) Sets the index of the current scanner position.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJavadocScanner

public DefaultJavadocScanner(List<JavadocToken> tokens,
                             int successorStartsAt)

Creates a new instance.

Parameters:

tokens - the tokens

successorStartsAt - the character position of the successive EOF token

Method Detail

newInstance

public static DefaultJavadocScanner newInstance(String text)

Creates a new instance from the documentation comment string.

Parameters:

text - the target text

Returns:

the created instance

Throws:

IllegalArgumentException - if the parameter is null

getTokens

public List<JavadocToken> getTokens()

Description copied from interface: JavadocScanner

Returns the tokens.

Specified by:

getTokens in interface JavadocScanner

Returns:

the tokens

getIndex

public int getIndex()

Description copied from interface: JavadocScanner

Returns the next token index.

Specified by:

getIndex in interface JavadocScanner

Returns:

the next token index

seek

public void seek(int position)

Description copied from interface: JavadocScanner

Sets the index of the current scanner position.

Specified by:

seek in interface JavadocScanner

Parameters:

position - the index which indicates the next token

consume

public void consume(int count)

Description copied from interface: JavadocScanner

Consumes the tokens.

Specified by:

consume in interface JavadocScanner

Parameters:

count - the number of tokens to be consumed

nextToken

public JavadocToken nextToken()

Description copied from interface: JavadocScanner

Consumes the next token and returns it.

Specified by:

nextToken in interface JavadocScanner

Returns:

the next token

lookahead

public JavadocToken lookahead(int offset)

Description copied from interface: JavadocScanner

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

Specified by:

lookahead in interface JavadocScanner

Parameters:

offset - the token offset

Returns:

the look-ahead token

toString

public String toString()

Overrides:

toString in class Object