com.asakusafw.utils.java.model.util

Class JavadocBuilder

java.lang.Object

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

public class JavadocBuilder
extends Object

A builder for building Javadoc.

Since:

0.1.0

Version:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavadocBuilder.DocElementFactory Creates DocElement.
static interface	JavadocBuilder.Placeholder A document placeholder.

Constructor Summary

Constructors

Constructor and Description
JavadocBuilder(ModelFactory factory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
JavadocBuilder	block(String tag) Starts a new block in this builder.
JavadocBuilder	code(String pattern, Object... arguments) Appends a @code inline block into this builder.
JavadocBuilder	copy() Returns a copy of this builder.
JavadocBuilder	exception(Type type) Starts a @throws tag block for the target type in this builder.
JavadocBuilder	inline(DocElement element) Appends an inline element into this builder.
JavadocBuilder	inline(List<? extends DocElement> elems) Appends inline elements into this builder.
JavadocBuilder	inline(String pattern, JavadocBuilder.Placeholder... placeholders) Appends inline elements into this builder.
JavadocBuilder	link(DocElement element) Appends a @link inline block for the target element into this builder.
JavadocBuilder	linkField(SimpleName name) Appends a @link inline block for the target field into this builder.
JavadocBuilder	linkField(String name) Appends a @link inline block for the target field into this builder.
JavadocBuilder	linkField(Type type, SimpleName name) Appends a @link inline block for the target field into this builder.
JavadocBuilder	linkField(Type type, String name) Appends a @link inline block for the target field into this builder.
JavadocBuilder	linkMethod(SimpleName name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(SimpleName name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(String name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(String name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(Type type, SimpleName name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(Type type, SimpleName name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(Type type, String name, List<? extends Type> parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkMethod(Type type, String name, Type... parameterTypes) Appends a @link inline block for the target method into this builder.
JavadocBuilder	linkType(Type type) Appends a @link inline block for the target type into this builder.
JavadocBuilder	param(SimpleName name) Starts a @param tag block for the target parameter in this builder.
JavadocBuilder	param(String name) Starts a @param tag block for the target parameter in this builder.
JavadocBuilder	returns() Starts a @return tag block in this builder.
JavadocBuilder	see(DocElement element) Starts @see tag block about the specified element in this builder.
JavadocBuilder	seeField(SimpleName name) Starts a @see tag block for the target field in this builder.
JavadocBuilder	seeField(String name) Starts a @see tag block for the target field in this builder.
JavadocBuilder	seeField(Type type, SimpleName name) Starts a @see tag block for the target field in this builder.
JavadocBuilder	seeField(Type type, String name) Starts a @see tag block for the target field in this builder.
JavadocBuilder	seeMethod(SimpleName name, List<? extends Type> parameterTypes) Starts a @see tag block for the target method in this builder.
JavadocBuilder	seeMethod(SimpleName name, Type... parameterTypes) Starts a @see tag block for the target method in this builder.
JavadocBuilder	seeMethod(String name, List<? extends Type> parameterTypes) Starts a @see tag block for the target method in this builder.
JavadocBuilder	seeMethod(String name, Type... parameterTypes) Starts a @see tag block for the target method in this builder.
JavadocBuilder	seeMethod(Type type, SimpleName name, List<? extends Type> parameterTypes) Starts @see tag block about the specified element in this builder.
JavadocBuilder	seeMethod(Type type, SimpleName name, Type... parameterTypes) Starts @see tag block about the specified element in this builder.
JavadocBuilder	seeMethod(Type type, String name, List<? extends Type> parameterTypes) Starts a @see tag block for the target method in this builder.
JavadocBuilder	seeMethod(Type type, String name, Type... parameterTypes) Starts a @see tag block for the target method in this builder.
JavadocBuilder	seeType(Type type) Starts a @see tag block for the target type in this builder.
JavadocBuilder	text(String pattern, Object... arguments) Appends a plain text into this builder.
Javadoc	toJavadoc() Returns the built Javadoc object.
JavadocBuilder	typeParam(SimpleName name) Starts a @param tag block for the target type parameter in this builder.
JavadocBuilder	typeParam(String name) Starts a @param tag block for the target type parameter in this builder.
JavadocBuilder	typeParam(Type typeVariable) Starts a @param tag block for the target type parameter in this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocBuilder

public JavadocBuilder(ModelFactory factory)

Creates a new instance.

Parameters:

factory - the Java DOM factory

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

copy

public JavadocBuilder copy()

Returns a copy of this builder.

Returns:

the copy

toJavadoc

public Javadoc toJavadoc()

Returns the built Javadoc object.

Returns:

the built object

block

public JavadocBuilder block(String tag)

Starts a new block in this builder. The current building block will be finished before this operation.

Parameters:

tag - the block tag (the starting "@" can be omitted)

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

inline

public JavadocBuilder inline(DocElement element)

Appends an inline element into this builder.

Parameters:

element - the target element

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

inline

public JavadocBuilder inline(List<? extends DocElement> elems)

Appends inline elements into this builder.

Parameters:

elems - the target elements

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

inline

public JavadocBuilder inline(String pattern,
                             JavadocBuilder.Placeholder... placeholders)

Appends inline elements into this builder.

Parameters:

pattern - the pattern string that can include {n}

placeholders - the placeholders

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

param

public JavadocBuilder param(String name)

Starts a @param tag block for the target parameter in this builder. The current building block will be finished before this operation.

Parameters:

name - the target parameter name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

param

public JavadocBuilder param(SimpleName name)

Starts a @param tag block for the target parameter in this builder. The current building block will be finished before this operation.

Parameters:

name - the target parameter name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

typeParam

public JavadocBuilder typeParam(String name)

Starts a @param tag block for the target type parameter in this builder. The current building block will be finished before this operation.

Parameters:

name - the target parameter name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

typeParam

public JavadocBuilder typeParam(SimpleName name)

Starts a @param tag block for the target type parameter in this builder. The current building block will be finished before this operation.

Parameters:

name - the target parameter name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

typeParam

public JavadocBuilder typeParam(Type typeVariable)

Starts a @param tag block for the target type parameter in this builder. The current building block will be finished before this operation.

Parameters:

typeVariable - the type variable

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

returns

public JavadocBuilder returns()

Starts a @return tag block in this builder. The current building block will be finished before this operation.

Returns:

this

exception

public JavadocBuilder exception(Type type)

Starts a @throws tag block for the target type in this builder. The current building block will be finished before this operation.

Parameters:

type - the target exception type

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeType

public JavadocBuilder seeType(Type type)

Starts a @see tag block for the target type in this builder. The current building block will be finished before this operation.

Parameters:

type - the target type

Returns:

this

seeField

public JavadocBuilder seeField(String name)

Starts a @see tag block for the target field in this builder. The current building block will be finished before this operation.

Parameters:

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeField

public JavadocBuilder seeField(Type type,
                               String name)

Starts a @see tag block for the target field in this builder. The current building block will be finished before this operation.

Parameters:

type - the target field type

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeField

public JavadocBuilder seeField(SimpleName name)

Starts a @see tag block for the target field in this builder. The current building block will be finished before this operation.

Parameters:

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeField

public JavadocBuilder seeField(Type type,
                               SimpleName name)

Starts a @see tag block for the target field in this builder. The current building block will be finished before this operation.

Parameters:

type - the target field type

name - the target field name

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeMethod

public JavadocBuilder seeMethod(String name,
                                Type... parameterTypes)

Starts a @see tag block for the target method in this builder. The current building block will be finished before this operation.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeMethod

public JavadocBuilder seeMethod(String name,
                                List<? extends Type> parameterTypes)

Starts a @see tag block for the target method in this builder. The current building block will be finished before this operation.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeMethod

public JavadocBuilder seeMethod(SimpleName name,
                                Type... parameterTypes)

Starts a @see tag block for the target method in this builder. The current building block will be finished before this operation.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeMethod

public JavadocBuilder seeMethod(SimpleName name,
                                List<? extends Type> parameterTypes)

Starts a @see tag block for the target method in this builder. The current building block will be finished before this operation.

Parameters:

name - the target method name

parameterTypes - the target method parameter types

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

seeMethod

public JavadocBuilder seeMethod(Type type,
                                String name,
                                Type... parameterTypes)

Starts a @see tag block for the target method in this builder. The current building block will be finished before this operation.

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

seeMethod

public JavadocBuilder seeMethod(Type type,
                                String name,
                                List<? extends Type> parameterTypes)

Starts a @see tag block for the target method in this builder. The current building block will be finished before this operation.

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

seeMethod

public JavadocBuilder seeMethod(Type type,
                                SimpleName name,
                                Type... parameterTypes)

Starts @see tag block about the specified element in this builder. The current building block will be finished before this operation.

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

seeMethod

public JavadocBuilder seeMethod(Type type,
                                SimpleName name,
                                List<? extends Type> parameterTypes)

Starts @see tag block about the specified element in this builder. The current building block will be finished before this operation.

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

see

public JavadocBuilder see(DocElement element)

Starts @see tag block about the specified element in this builder. The current building block will be finished before this operation.

Parameters:

element - the target element

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

text

public JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder linkType(Type type)

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

Parameters:

type - the target type

Returns:

this

linkField

public JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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 JavadocBuilder 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