com.asakusafw.utils.java.parser.javadoc

Class JavadocBlockParser

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.JavadocBaseParser

com.asakusafw.utils.java.parser.javadoc.JavadocBlockParser

Direct Known Subclasses:

AcceptableJavadocBlockParser, DefaultJavadocBlockParser

public abstract class JavadocBlockParser
extends JavadocBaseParser

An abstract super class of Java documentation comment block parsers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavadocBlockParser() Creates a new instance without any inline block parsers.
protected	JavadocBlockParser(List<? extends JavadocBlockParser> blockParsers) Creates a new instance with inline block parsers.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canAccept(String tag) Returns whether this parser can accept the block with target tag name.
IrDocBasicType	fetchBasicType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded basic type.
IrDocField	fetchField(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded field.
IrDocFragment	fetchLinkTarget(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded link target.
IrDocMethod	fetchMethod(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded method or constructor.
IrDocName	fetchName(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded (simple or qualified) name.
IrDocNamedType	fetchNamedType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded named type.
IrDocBasicType	fetchPrimitiveType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded primitive type.
List<IrDocFragment>	fetchRestFragments(JavadocScanner scanner) Consumes all tokens from the scanner, and converts them to a list of IrDocFragments.
IrDocSimpleName	fetchSimpleName(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded simple name.
IrDocType	fetchType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded type.
IrDocBlock	newBlock(String tag, List<? extends IrDocFragment> fragments) Creates a new block from its tag and fragments.
abstract IrDocBlock	parse(String tag, JavadocScanner scanner) Parses a block.

Methods inherited from class com.asakusafw.utils.java.parser.javadoc.JavadocBaseParser

getBlockParsers, parseBlock, setBlockParsers

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocBlockParser

protected JavadocBlockParser()

Creates a new instance without any inline block parsers.

JavadocBlockParser

protected JavadocBlockParser(List<? extends JavadocBlockParser> blockParsers)

Creates a new instance with inline block parsers.

Parameters:

blockParsers - the inline block parsers

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

canAccept

public abstract boolean canAccept(String tag)

Returns whether this parser can accept the block with target tag name. If the target is an synopsis block, the tag name will be null.

Parameters:

tag - the target tag name (without "@"), or null for synopsis blocks

Returns:

true if this parser can accept the target block, otherwise false

parse

public abstract IrDocBlock parse(String tag,
                                 JavadocScanner scanner)
                          throws JavadocParseException

Parses a block. The scanner will provides contents of the target block (without its block tag).

Parameters:

tag - the target tag name (without "@"), or null for synopsis blocks

scanner - the scanner for providing block contents

Returns:

the parsed block

Throws:

JavadocParseException - if error occurred while parsing the target block

IllegalArgumentException - if scanner is null

newBlock

public IrDocBlock newBlock(String tag,
                           List<? extends IrDocFragment> fragments)

Creates a new block from its tag and fragments.

Parameters:

tag - the tag name, or null for synopsis blocks

fragments - the fragments

Returns:

the created block

Throws:

IllegalArgumentException - if fragments is null

fetchRestFragments

public List<IrDocFragment> fetchRestFragments(JavadocScanner scanner)
                                       throws JavadocParseException

Consumes all tokens from the scanner, and converts them to a list of IrDocFragments.

Parameters:

scanner - the target scanner

Returns:

the converted fragments

Throws:

JavadocParseException - if error was occurred while converting tokens

IllegalArgumentException - if the parameter is null

fetchSimpleName

public IrDocSimpleName fetchSimpleName(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchName

public IrDocName fetchName(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchBasicType

public IrDocBasicType fetchBasicType(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchPrimitiveType

public IrDocBasicType fetchPrimitiveType(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchNamedType

public IrDocNamedType fetchNamedType(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchType

public IrDocType fetchType(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchField

public IrDocField fetchField(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchMethod

public IrDocMethod fetchMethod(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null

fetchLinkTarget

public IrDocFragment fetchLinkTarget(JavadocScanner scanner)

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

Returns:

the analyzed element if this operation was successfully completed, otherwise null

Throws:

IllegalArgumentException - if the parameter is null