com.asakusafw.utils.java.parser.javadoc

Class DefaultJavadocBlockParser

java.lang.Object

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

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

com.asakusafw.utils.java.parser.javadoc.DefaultJavadocBlockParser

public class DefaultJavadocBlockParser
extends JavadocBlockParser

An implementation of JavadocBaseParser which parses generic blocks.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canAccept(String tag) Returns whether this parser can accept the block with target tag name.
IrDocBlock	parse(String tag, JavadocScanner scanner) Parses a block.

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

fetchBasicType, fetchField, fetchLinkTarget, fetchMethod, fetchName, fetchNamedType, fetchPrimitiveType, fetchRestFragments, fetchSimpleName, fetchType, newBlock

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

DefaultJavadocBlockParser

public DefaultJavadocBlockParser()

Creates a new instance without any inline block parsers.

DefaultJavadocBlockParser

public DefaultJavadocBlockParser(List<? extends JavadocBlockParser> blockParsers)

Creates a new instance with inline block parsers.

Parameters:

blockParsers - the supported inline block parsers

Method Detail

canAccept

public boolean canAccept(String tag)

Description copied from class: JavadocBlockParser

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.

Specified by:

canAccept in class JavadocBlockParser

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 IrDocBlock parse(String tag,
                        JavadocScanner scanner)
                 throws JavadocParseException

Description copied from class: JavadocBlockParser

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

Specified by:

parse in class JavadocBlockParser

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