com.asakusafw.utils.java.parser.javadoc

Class JavadocBlockParserUtil

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.JavadocBlockParserUtil

public final class JavadocBlockParserUtil
extends Object

Utilities for JavadocBlockParser.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<JavadocTokenKind>	S_WHITE The white-space token kinds.

Method Summary

Modifier and Type	Method and Description
static String	buildString(List<? extends JavadocToken> tokens) Concatenates the token images.
static int	countWhileTagName(JavadocScanner scanner, int start) Returns the number of tokens in the current block body.
static IrDocBasicType	fetchBasicType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded basic type.
static JavadocBlockInfo	fetchBlockInfo(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded inline block.
static IrDocField	fetchField(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded field.
static IrDocFragment	fetchLinkTarget(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded link target.
static IrDocMethod	fetchMethod(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded method or constructor.
static IrDocName	fetchName(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded (simple or qualified) name.
static IrDocNamedType	fetchNamedType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded named type.
static IrDocBasicType	fetchPrimitiveType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded primitive type.
static IrDocSimpleName	fetchSimpleName(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded simple name.
static IrDocText	fetchText(JavadocScanner scanner, boolean trimHead, boolean trimTail) Consumes tokens from the scanner and returns the corresponded plain text.
static IrDocType	fetchType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded type.
static <T extends IrDocElement> T	setLocation(T elem, IrLocation start, IrLocation stop) Sets the location information for the target element.
static <T extends IrDocElement> T	setLocation(T elem, JavadocToken start, JavadocToken stop) Sets the location information for the target element.

Methods inherited from class java.lang.Object

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

Field Detail

S_WHITE

public static final Set<JavadocTokenKind> S_WHITE

The white-space token kinds.

Method Detail

setLocation

public static <T extends IrDocElement> T setLocation(T elem,
                                                     JavadocToken start,
                                                     JavadocToken stop)

Sets the location information for the target element. This will do nothing if some locations are unknown.

Type Parameters:

T - the element type

Parameters:

elem - the target element

start - the first token

stop - the last token

Returns:

the target element (location may be set)

setLocation

public static <T extends IrDocElement> T setLocation(T elem,
                                                     IrLocation start,
                                                     IrLocation stop)

Sets the location information for the target element. This will do nothing if some locations are unknown.

Type Parameters:

T - the element type

Parameters:

elem - the target element

start - the first location

stop - the last location

Returns:

the target element (location may be set)

fetchText

public static IrDocText fetchText(JavadocScanner scanner,
                                  boolean trimHead,
                                  boolean trimTail)

Consumes tokens from the scanner and returns the corresponded plain text. Tokens will be removed from the scanner only if this operation was successfully completed. If the next plain text will be empty, this returns null (operation failed).

Parameters:

scanner - the target scanner

trimHead - true to trim leading white-spaces

trimTail - true to trim trailing while-spaces

Returns:

the consumed plain text, or null if it will be empty

Throws:

IllegalArgumentException - if the parameter is null

fetchBlockInfo

public static JavadocBlockInfo fetchBlockInfo(JavadocScanner scanner)

Consumes tokens from the scanner and returns the corresponded inline block. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

Returns:

the next inline block if this operation was succeeded, or null

Throws:

IllegalArgumentException - if the parameter is null

countWhileTagName

public static int countWhileTagName(JavadocScanner scanner,
                                    int start)

Returns the number of tokens in the current block body.

Parameters:

scanner - the target scanner

start - the starting offset

Returns:

the number of tokens

fetchSimpleName

public static IrDocSimpleName fetchSimpleName(JavadocScanner scanner,
                                              Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded simple name. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchName

public static IrDocName fetchName(JavadocScanner scanner,
                                  Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded (simple or qualified) name. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchBasicType

public static IrDocBasicType fetchBasicType(JavadocScanner scanner,
                                            Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded basic type. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchPrimitiveType

public static IrDocBasicType fetchPrimitiveType(JavadocScanner scanner,
                                                Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded primitive type. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchNamedType

public static IrDocNamedType fetchNamedType(JavadocScanner scanner,
                                            Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded named type. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchType

public static IrDocType fetchType(JavadocScanner scanner,
                                  Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded type. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchField

public static IrDocField fetchField(JavadocScanner scanner,
                                    Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded field. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchMethod

public static IrDocMethod fetchMethod(JavadocScanner scanner,
                                      Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded method or constructor. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

fetchLinkTarget

public static IrDocFragment fetchLinkTarget(JavadocScanner scanner,
                                            Set<JavadocTokenKind> follow)

Consumes tokens from the scanner and returns the corresponded link target. The link target means one of type, field, method, or constructor. This will ignore successive while space tokens, and tokens are removed from the scanner only if this operation was successfully completed.

Parameters:

scanner - the target scanner

follow - the acceptable token kinds after this operation was finished, or null to accept anything

Returns:

the next element if this operation was succeeded, or null

Throws:

IllegalArgumentException - if scanner is null

buildString

public static String buildString(List<? extends JavadocToken> tokens)

Concatenates the token images.

Parameters:

tokens - the target tokens

Returns:

the concatenated string