com.asakusafw.utils.java.parser.javadoc

Class AcceptableJavadocBlockParser

java.lang.Object

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

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

com.asakusafw.utils.java.parser.javadoc.AcceptableJavadocBlockParser

Direct Known Subclasses:

FollowsNamedTypeBlockParser, FollowsReferenceBlockParser, ParamBlockParser, SerialFieldBlockParser

public abstract class AcceptableJavadocBlockParser
extends JavadocBlockParser

An implementation of JavadocBaseParser which accepts tag blocks by their tag name.

Constructor Summary

Constructors

Constructor and Description
AcceptableJavadocBlockParser() Creates a new instance.
AcceptableJavadocBlockParser(String[] tagNames) Creates a new instance.
AcceptableJavadocBlockParser(String tagName, String... tagNames) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	canAccept(String tag) Returns whether this parser can accept the block with target tag name.

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

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

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

AcceptableJavadocBlockParser

public AcceptableJavadocBlockParser()

Creates a new instance.

AcceptableJavadocBlockParser

public AcceptableJavadocBlockParser(String tagName,
                                    String... tagNames)

Creates a new instance.

Parameters:

tagName - the first acceptable tag name

tagNames - the rest acceptable tag names

AcceptableJavadocBlockParser

public AcceptableJavadocBlockParser(String[] tagNames)

Creates a new instance.

Parameters:

tagNames - the acceptable tag names

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