com.asakusafw.utils.java.parser.javadoc

Class JavadocBaseParser

java.lang.Object

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

Direct Known Subclasses:

JavadocBlockParser, JavadocParser

public abstract class JavadocBaseParser
extends Object

An abstract super class of Java documentation comment parsers.

Constructor Summary

Constructors

Constructor and Description
JavadocBaseParser(List<? extends JavadocBlockParser> blockParsers) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
List<? extends JavadocBlockParser>	getBlockParsers() Returns the block parsers.
IrDocBlock	parseBlock(JavadocBlockInfo block) Parses the target block and returns the block information.
void	setBlockParsers(List<? extends JavadocBlockParser> blockParsers) Sets the block parsers.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocBaseParser

public JavadocBaseParser(List<? extends JavadocBlockParser> blockParsers)

Creates a new instance.

Parameters:

blockParsers - the block parsers

Method Detail

getBlockParsers

public final List<? extends JavadocBlockParser> getBlockParsers()

Returns the block parsers.

Returns:

the block parsers

setBlockParsers

public final void setBlockParsers(List<? extends JavadocBlockParser> blockParsers)

Sets the block parsers.

Parameters:

blockParsers - the block parsers

Throws:

IllegalArgumentException - if the parameter is null

parseBlock

public IrDocBlock parseBlock(JavadocBlockInfo block)
                      throws JavadocParseException

Parses the target block and returns the block information.

Parameters:

block - the target block

Returns:

the parsed information

Throws:

JavadocParseException - if error was occurred while analyzing the target block

IllegalArgumentException - if the parameter is null