com.asakusafw.utils.java.parser.javadoc

Class JavadocScannerUtil

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.JavadocScannerUtil

public final class JavadocScannerUtil
extends Object

Utilities for JavadocScanner.

Method Summary

Modifier and Type	Method and Description
static int	consumeLineEnd(JavadocScanner scanner, boolean multiline) Consumes the next line-break, and its consequent white-space, and asterisk tokens.
static int	countUntil(Collection<JavadocTokenKind> kinds, JavadocScanner scanner, int start) Returns the number of tokens from the starting index until each token has the specified kind.
static int	countUntilBlockEnd(JavadocScanner scanner, int start) Returns the number of tokens from the starting index until the current block was closed.
static int	countUntilCommentEnd(JavadocScanner scanner, boolean returnMinusIfMissing, int start) Returns the number of tokens from the starting index until the end of this comment.
static int	countUntilNextLineStart(JavadocScanner scanner, int start) Returns the number of tokens from the starting index until the next printable token on the subsequent lines.
static int	countUntilNextPrintable(JavadocScanner scanner, int start) Returns the number of tokens from the starting index until the next printable token.
static int	countWhile(Collection<JavadocTokenKind> kinds, JavadocScanner scanner, int start) Returns the number of tokens from the starting index while each token has the specified kind.
static List<JavadocToken>	lookaheadTokens(JavadocScanner scanner, int start, int count) Returns the a sequence of tokens.

Methods inherited from class java.lang.Object

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

Method Detail

lookaheadTokens

public static List<JavadocToken> lookaheadTokens(JavadocScanner scanner,
                                                 int start,
                                                 int count)

Returns the a sequence of tokens. This will returns number of tokens specified by count, except EOF token (JavadocTokenKind.EOF) and its trailing tokens.

Parameters:

scanner - the target scanner

start - the starting index

count - the max token count

Returns:

the tokens in the range

countWhile

public static int countWhile(Collection<JavadocTokenKind> kinds,
                             JavadocScanner scanner,
                             int start)

Returns the number of tokens from the starting index while each token has the specified kind.

Parameters:

kinds - the target kinds (JavadocTokenKind.EOF will be ignored)

scanner - the target scanner

start - the starting index

Returns:

the number of tokens

countUntil

public static int countUntil(Collection<JavadocTokenKind> kinds,
                             JavadocScanner scanner,
                             int start)

Returns the number of tokens from the starting index until each token has the specified kind.

Parameters:

kinds - the target kinds (JavadocTokenKind.EOF will be always enabled)

scanner - the target scanner

start - the starting index

Returns:

the number of tokens

countUntilBlockEnd

public static int countUntilBlockEnd(JavadocScanner scanner,
                                     int start)

Returns the number of tokens from the starting index until the current block was closed. The terminal token will be not in the count.

Parameters:

scanner - the target scanner

start - the starting index

Returns:

the number of tokens

countUntilCommentEnd

public static int countUntilCommentEnd(JavadocScanner scanner,
                                       boolean returnMinusIfMissing,
                                       int start)

Returns the number of tokens from the starting index until the end of this comment.

Parameters:

scanner - the target scanner

returnMinusIfMissing - true to return -1 if missing the end of comment, or false to return the number of tokens if missing it

start - the starting index

Returns:

the number of tokens

countUntilNextPrintable

public static int countUntilNextPrintable(JavadocScanner scanner,
                                          int start)

Returns the number of tokens from the starting index until the next printable token. Note that white spaces and asterisks on beginning of lines are NOT printable.

Parameters:

scanner - the target scanner

start - the starting index

Returns:

the number of tokens

countUntilNextLineStart

public static int countUntilNextLineStart(JavadocScanner scanner,
                                          int start)

Returns the number of tokens from the starting index until the next printable token on the subsequent lines. If there is no subsequent lines or no such a printable token, this will returns the number of tokens until EOF. Note that white spaces and asterisks on beginning of lines are NOT printable.

Parameters:

scanner - the target scanner

start - the starting index

Returns:

the number of tokens

consumeLineEnd

public static int consumeLineEnd(JavadocScanner scanner,
                                 boolean multiline)

Consumes the next line-break, and its consequent white-space, and asterisk tokens. With multiline option, this also consumes them on the subsequent lines.

Parameters:

scanner - the target scanner

multiline - true to consume line end on multiple lines, otherwise false

Returns:

the consumed number of lines