com.asakusafw.utils.java.model.util

Class JavadocBuilder.DocElementFactory

java.lang.Object

com.asakusafw.utils.java.model.util.JavadocBuilder.DocElementFactory

Enclosing class:

JavadocBuilder

public static class JavadocBuilder.DocElementFactory
extends Object

Creates DocElement.

Since:

0.9.0

Method Summary

Modifier and Type	Method and Description
DocElement	code(Object text) Appends a @code inline block into this builder.
DocElement	code(String pattern, Object... arguments) Appends a @code inline block into this builder.
DocElement	link(DocElement element) Appends a @link inline block for the target element into this builder.
DocElement	linkField(SimpleName name) Appends a @link inline block for the target field into this builder.
DocElement	linkField(String name) Appends a @link inline block for the target field into this builder.
DocElement	linkField(Type type, SimpleName name) Appends a @link inline block for the target field into this builder.
DocElement	linkField(Type type, String name) Appends a @link inline block for the target field into this builder.
DocElement	linkMethod(SimpleName name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(SimpleName name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(String name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(String name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(Type type, SimpleName name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(Type type, SimpleName name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(Type type, String name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkMethod(Type type, String name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
DocElement	linkType(Type type) Appends a @link inline block for the target type into this builder.
DocElement	text(Object text) Appends a plain text into this builder.
DocElement	text(String pattern, Object... arguments) Appends a plain text into this builder.

Methods inherited from class java.lang.Object

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

Method Detail

text

public DocElement text(Object text)

Appends a plain text into this builder.

Parameters:

text - the text

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

text

public DocElement text(String pattern,
                       Object... arguments)

Appends a plain text into this builder.

Parameters:

pattern - the text pattern in form of MessageFormat.format(String, Object...)

arguments - the arguments for the pattern

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

code

public DocElement code(Object text)

Appends a @code inline block into this builder.

Parameters:

text - the text

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

code

public DocElement code(String pattern,
                       Object... arguments)

Appends a @code inline block into this builder.

Parameters:

pattern - the text pattern in form of MessageFormat.format(String, Object...)

arguments - the arguments for the pattern

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkType

public DocElement linkType(Type type)

Appends a @link inline block for the target type into this builder.

Parameters:

type - the target type

Returns:

this

linkField

public DocElement linkField(String name)

Appends a @link inline block for the target field into this builder.

Parameters:

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkField

public DocElement linkField(Type type,
                            String name)

Appends a @link inline block for the target field into this builder.

Parameters:

type - the target field type

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkField

public DocElement linkField(SimpleName name)

Appends a @link inline block for the target field into this builder.

Parameters:

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkField

public DocElement linkField(Type type,
                            SimpleName name)

Appends a @link inline block for the target field into this builder.

Parameters:

type - the target field type

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(String name,
                             Type... parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(String name,
                             List<? extends Type> parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(SimpleName name,
                             Type... parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(SimpleName name,
                             List<? extends Type> parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(Type type,
                             String name,
                             Type... parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

type - the target method type

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(Type type,
                             String name,
                             List<? extends Type> parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

type - the target method type

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(Type type,
                             SimpleName name,
                             Type... parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

type - the target method type

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

linkMethod

public DocElement linkMethod(Type type,
                             SimpleName name,
                             List<? extends Type> parameterTypes)

Appends a @link inline block for the target method into this builder.

Parameters:

type - the target method type

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

link

public DocElement link(DocElement element)

Appends a @link inline block for the target element into this builder.

Parameters:

element - the target element

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null