com.asakusafw.operator.util

Class JavadocHelper

java.lang.Object

com.asakusafw.operator.util.JavadocHelper

public class JavadocHelper
extends Object

Common helper methods about documentation comments.

Constructor Summary

Constructors

Constructor and Description
JavadocHelper(CompileEnvironment environment) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
List<? extends DocElement>	get(OperatorDescription.Document document) Returns the document elements for the description.
List<? extends DocElement>	getParameter(String name) Returns the parameter document elements.
List<? extends DocElement>	getTypeParameter(String name) Returns the type parameter document elements.
void	put(Element element) Put a documented element.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocHelper

public JavadocHelper(CompileEnvironment environment)

Creates a new instance.

Parameters:

environment - current environment

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

put

public void put(Element element)

Put a documented element.

Parameters:

element - the documented element

Throws:

IllegalArgumentException - if some parameters were null

get

public List<? extends DocElement> get(OperatorDescription.Document document)

Returns the document elements for the description.

Parameters:

document - description

Returns:

related elements, or an empty list if they are not found

Throws:

IllegalArgumentException - if some parameters were null

getParameter

public List<? extends DocElement> getParameter(String name)

Returns the parameter document elements.

Parameters:

name - parameter name

Returns:

related elements, or an empty list if the parameter does not exist

Throws:

IllegalArgumentException - if some parameters were null

getTypeParameter

public List<? extends DocElement> getTypeParameter(String name)

Returns the type parameter document elements.

Parameters:

name - type parameter name

Returns:

related elements, or an empty list if the type parameter does not exist

Throws:

IllegalArgumentException - if some parameters were null