org.ashikunep.irenka.toolkit
インタフェース DocFactory

すべてのスーパーインタフェース:

Tool

public interface DocFactory
extends Tool

CtDocBlock以降の要素を生成するファクトリ。

バージョン:

$Date: 2008-02-12 12:35:47 +0900 (火, 12 2月 2008) $

作成者:

Suguru ARAKAWA (Gluegent, Inc.)

メソッドの概要

DocFactory	borrow() このツールを借りる。
CtDocArrayType	newDocArrayType(CtDocType componentType) Creates and returns a new (CtDocArrayType).
CtDocBasicType	newDocBasicType(TypeKind kind) Creates and returns a new (CtDocBasicType).
CtDocBlock	newDocBlock(String tag) Creates and returns a new (CtDocBlock).
CtDocField	newDocField(CtDocNamedType declaring, CtDocSimpleName name) Creates and returns a new (CtDocField).
CtDocMethod	newDocMethod(CtDocNamedType declaring, CtDocSimpleName name, List<? extends CtDocMethodParameter> params) Creates and returns a new (CtDocMethod).
CtDocMethodParameter	newDocMethodParameter(CtDocType type, CtDocSimpleName name) Creates and returns a new (CtDocMethodParameter).
CtDocMethodParameter	newDocMethodParameter(CtDocType type, CtDocSimpleName name, boolean varargs) Creates and returns a new (CtDocMethodParameter).
CtDocNamedType	newDocNamedType(CtDocName name) Creates and returns a new (CtDocNamedType).
CtDocQualifiedName	newDocQualifiedName(CtDocName qualifier, CtDocSimpleName simpleName) Creates and returns a new (CtDocQualifiedName).
CtDocSimpleName	newDocSimpleName(String identifier) Creates and returns a new (CtDocSimpleName).
CtDocText	newDocText(String content) Creates and returns a new (CtDocText).
CtJavadoc	newJavadoc() Creates and returns a new documentation comment (CtJavadoc).
CtDocBlock	parseDocBlock(String text) Javadocに含まれるブロックを構成する文字列を解析し、対応する構造を返す。
CtJavadoc	parseJavadoc(String text) Javadocを構成する文字列を解析し、対応する構造を返す。

メソッドの詳細

newJavadoc

CtJavadoc newJavadoc()

Creates and returns a new documentation comment (CtJavadoc).

戻り値:

A new element

newDocBlock

CtDocBlock newDocBlock(String tag)

Creates and returns a new (CtDocBlock).

パラメータ:

tag - tag name, or null if synopsis block

戻り値:

A new element

newDocArrayType

CtDocArrayType newDocArrayType(CtDocType componentType)

Creates and returns a new (CtDocArrayType).

パラメータ:

componentType - component type

戻り値:

A new element

newDocBasicType

CtDocBasicType newDocBasicType(TypeKind kind)

Creates and returns a new (CtDocBasicType).

パラメータ:

kind - Kind of the type

戻り値:

A new element

newDocNamedType

CtDocNamedType newDocNamedType(CtDocName name)

Creates and returns a new (CtDocNamedType).

パラメータ:

name - name of the type

戻り値:

A new element

newDocField

CtDocField newDocField(CtDocNamedType declaring,
                       CtDocSimpleName name)

Creates and returns a new (CtDocField).

パラメータ:

declaring - (nullable)

name - name

戻り値:

A new element

newDocMethod

CtDocMethod newDocMethod(CtDocNamedType declaring,
                         CtDocSimpleName name,
                         List<? extends CtDocMethodParameter> params)

Creates and returns a new (CtDocMethod).

パラメータ:

declaring - (nullable)

name - name

params - parameters

戻り値:

A new element

newDocMethodParameter

CtDocMethodParameter newDocMethodParameter(CtDocType type,
                                           CtDocSimpleName name)

Creates and returns a new (CtDocMethodParameter).

パラメータ:

type - type of this parameter

name - name (nullable)

戻り値:

A new element

newDocMethodParameter

CtDocMethodParameter newDocMethodParameter(CtDocType type,
                                           CtDocSimpleName name,
                                           boolean varargs)

Creates and returns a new (CtDocMethodParameter).

パラメータ:

type - Type of this parameter

name - name (nullable)

varargs - If true, parameter has variable arity

戻り値:

A new element

newDocSimpleName

CtDocSimpleName newDocSimpleName(String identifier)

Creates and returns a new (CtDocSimpleName).

パラメータ:

identifier - Identifier of this name

戻り値:

A new element

newDocQualifiedName

CtDocQualifiedName newDocQualifiedName(CtDocName qualifier,
                                       CtDocSimpleName simpleName)

Creates and returns a new (CtDocQualifiedName).

パラメータ:

qualifier - qualifier of this name

simpleName - the last name

戻り値:

A new element

newDocText

CtDocText newDocText(String content)

Creates and returns a new (CtDocText).

パラメータ:

content - text

戻り値:

A new element

parseJavadoc

CtJavadoc parseJavadoc(String text)

Javadocを構成する文字列を解析し、対応する構造を返す。

パラメータ:

text - Javadocを構成する文字列

戻り値:

解析した構造

例外:

NullPointerException - 引数にnullが含まれていた場合

IllegalArgumentException - 引数がJavadocを構成しない場合

parseDocBlock

CtDocBlock parseDocBlock(String text)

Javadocに含まれるブロックを構成する文字列を解析し、対応する構造を返す。

パラメータ:

text - Javadocに含まれるブロックを構成する文字列

戻り値:

解析した構造

例外:

NullPointerException - 引数にnullが含まれていた場合

IllegalArgumentException - 引数がJavadocに含まれるブロックを構成しない場合

borrow

DocFactory borrow()

インタフェース Tool の記述:

このツールを借りる。

定義:

インタフェース Tool 内の borrow

戻り値:

借りるツール