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

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

Tool

public interface DeclarationFactory
extends Tool

Irenkaで使用する型を生成するファクトリ。

バージョン:

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

作成者:

Suguru ARAKAWA (Gluegent, Inc.)

メソッドの概要

<R extends Annotation> CtAnnotation<R>	annotationOf(Class<R> type) 指定した実行時型に対応する注釈の宣言を返す。
<C> CtArray<C>	arrayOf(CtType<C> component) 指定した型を要素型に持つ配列型を返す。
DeclarationFactory	borrow() このツールを借りる。
<R> CtClass<R>	classOf(Class<R> type) 指定した実行時型に対応するクラスの宣言を返す。
<R extends Enum<?>> CtEnum<R>	enumOf(Class<R> type) 指定した実行時型に対応する列挙の宣言を返す。
<R> CtInterface<R>	interfaceOf(Class<R> type) 指定した実行時型に対応するインターフェースの宣言を返す。
<T extends Annotation> CtAnnotation<T>	newAnnotation(String simpleName) 最小限の構造を持つCtAnnotationの宣言を新しく生成して返す。
<T> CtAnnotationElement<T>	newAnnotationElement(CtType<T> type, String simpleName) 最小限の構造を持つCtAnnotationElementの宣言を新しく生成して返す。
<T> CtClass<T>	newClass(String simpleName) 最小限の構造を持つCtClassの宣言を新しく生成して返す。
<T> CtConstructor<T>	newConstructor(CtDeclaredType<T> parent) 最小限の構造を持つCtConstructorの宣言を新しく生成して返す。
<T extends Enum<?>> CtEnum<T>	newEnum(String simpleName) 最小限の構造を持つCtEnumの宣言を新しく生成して返す。
<T extends Enum<?>> CtEnumConstant<T>	newEnumConstant(CtEnum<T> parent, String simpleName) 最小限の構造を持つCtEnumConstantの宣言を新しく生成して返す。
<T> CtField<T>	newField(CtType<T> type, String simpleName) 最小限の構造を持つCtFieldの宣言を新しく生成して返す。
CtInitializer	newInitializer() 最小限の構造を持つCtInitializerの宣言を新しく生成して返す。
<T> CtInterface<T>	newInterface(String simpleName) 最小限の構造を持つCtInterfaceの宣言を新しく生成して返す。
<T> CtMethod<T>	newMethod(CtType<T> returnType, String simpleName) 最小限の構造を持つCtMethodの宣言を新しく生成して返す。
CtPackage	newPackage(String simpleName) 指定の名前を持つパッケージ片の宣言を新しく生成して返す。
CtPackage	packageOf(String name) 指定の名前を持つパッケージを返す。
CtPackage	packageOf(String name, boolean force) 指定の名前を持つパッケージを返す。
CtDeclaredType<?>	typeDeclarationOf(String typeName) 指定した名前の宣言型を返す。
<R> CtType<R>	typeOf(Class<R> type) 指定した実行時型に対応するコンパイル時型を返す。
CtType<?>	typeOf(String typeName) 指定した名前の型を返す。
CtType<?>	typeOf(TypeKind kind) TypeKindが表す特定可能な型を返す。
CtWildcard<?>	wildcard() バウンドを持たないワイルドカードを返す。
<T> CtWildcard<? extends T>	wildcardExtends(CtType<T> bound) 上限を持つワイルドカードを返す。
<T> CtWildcard<? super T>	wildcardSuper(CtType<T> bound) 下限を持つワイルドカードを返す。

メソッドの詳細

packageOf

CtPackage packageOf(String name)

指定の名前を持つパッケージを返す。 packageOf(name, true)を呼び出す。

パラメータ:

name - パッケージの名前

戻り値:

指定の名前を持つパッケージ、存在しない場合はnull

packageOf

CtPackage packageOf(String name,
                    boolean force)

指定の名前を持つパッケージを返す。 forceにfalseが指定された場合、ロード済みでないパッケージは無視される。

パラメータ:

name - パッケージの名前

force - trueが指定された場合、ロード済みでないパッケージはロード必要に応じてロードする

戻り値:

指定の名前を持つパッケージ、存在しない場合はnull

typeOf

CtType<?> typeOf(TypeKind kind)

TypeKindが表す特定可能な型を返す。 このメソッドでは、次の型を生成することはできない。

• CtArray (CtType.array())
• CtClass (classOf(Class))
• CtInterface (interfaceOf(Class))
• CtEnum (enumOf(Class))
• CtAnnotation (annotationOf(Class))
• CtTypeParameter (CtGenericReference.getTypeParameters())

パラメータ:

kind - 型の種類

戻り値:

指定した型の種類に対応するコンパイル時型

例外:

IllegalArgumentException - 生成できない型の種類が指定された場合

typeOf

<R> CtType<R> typeOf(Class<R> type)

指定した実行時型に対応するコンパイル時型を返す。 このメソッドでは、プリミティブ型の配列型を生成することはできない。

型パラメータ:

R - 実行時型

パラメータ:

type - 実行時型

戻り値:

指定した実行時型に対応するコンパイル時型

例外:

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

IllegalArgumentException - 生成できない型が指定された場合

typeOf

CtType<?> typeOf(String typeName)

指定した名前の型を返す。 このメソッドでは、次の型のみを検出できる。

• 基本型
• 宣言型(未加工型のみ)

パラメータ:

typeName - 型の名前

戻り値:

指定した名前を持つ型、検出できなかった場合はnull

typeDeclarationOf

CtDeclaredType<?> typeDeclarationOf(String typeName)

指定した名前の宣言型を返す。

パラメータ:

typeName - 型の名前

戻り値:

指定した名前を持つ型、検出できなかった場合はnull

classOf

<R> CtClass<R> classOf(Class<R> type)

指定した実行時型に対応するクラスの宣言を返す。 型変数を利用するには、返される値に対してCtDeclaredType.getParameterized(java.util.List)を続けて適用すればよい。

型パラメータ:

R - 実行時型

パラメータ:

type - 実行時型

戻り値:

指定した実行時型に対応するクラスの宣言

例外:

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

IllegalArgumentException - クラス型でない型が指定された場合

interfaceOf

<R> CtInterface<R> interfaceOf(Class<R> type)

指定した実行時型に対応するインターフェースの宣言を返す。 型変数を利用するには、返される値に対してCtDeclaredType.getParameterized(java.util.List)を続けて適用すればよい。

型パラメータ:

R - 実行時型

パラメータ:

type - 実行時型

戻り値:

指定した実行時型に対応するインターフェースの宣言

例外:

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

IllegalArgumentException - インターフェース型でない型が指定された場合

enumOf

<R extends Enum<?>> CtEnum<R> enumOf(Class<R> type)

指定した実行時型に対応する列挙の宣言を返す。 Enumそのものはは列挙型ではないため、classOf(Class)を利用する必要がある。

型パラメータ:

R - 実行時型

パラメータ:

type - 実行時型

戻り値:

指定した実行時型に対応する列挙の宣言

例外:

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

IllegalArgumentException - 列挙型でない型が指定された場合

annotationOf

<R extends Annotation> CtAnnotation<R> annotationOf(Class<R> type)

指定した実行時型に対応する注釈の宣言を返す。 Annotationそのものはは注釈型ではないため、interfaceOf(Class)を利用する必要がある。

型パラメータ:

R - 実行時型

パラメータ:

type - 実行時型

戻り値:

指定した実行時型に対応する注釈の宣言

例外:

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

IllegalArgumentException - 注釈型でない型が指定された場合

arrayOf

<C> CtArray<C> arrayOf(CtType<C> component)

指定した型を要素型に持つ配列型を返す。

型パラメータ:

C - 実行時の要素型

パラメータ:

component - 要素型

戻り値:

対応する配列型

wildcard

CtWildcard<?> wildcard()

バウンドを持たないワイルドカードを返す。 バウンドを持つワイルドカードを生成する場合、CtWildcardType#upperBounded(CtType)などを利用する。

戻り値:

バウンドを持たないワイルドカード

wildcardExtends

<T> CtWildcard<? extends T> wildcardExtends(CtType<T> bound)

上限を持つワイルドカードを返す。

型パラメータ:

T - 境界型

パラメータ:

bound - 上限境界

戻り値:

上限を持つワイルドカード

wildcardSuper

<T> CtWildcard<? super T> wildcardSuper(CtType<T> bound)

下限を持つワイルドカードを返す。

型パラメータ:

T - 境界型

パラメータ:

bound - 下限境界

戻り値:

下限を持つワイルドカード

newClass

<T> CtClass<T> newClass(String simpleName)

最小限の構造を持つCtClassの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 宣言の型

パラメータ:

simpleName - 単純名

戻り値:

生成した宣言

newInterface

<T> CtInterface<T> newInterface(String simpleName)

最小限の構造を持つCtInterfaceの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 宣言の型

パラメータ:

simpleName - 単純名

戻り値:

生成した宣言

newEnum

<T extends Enum<?>> CtEnum<T> newEnum(String simpleName)

最小限の構造を持つCtEnumの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 宣言の型

パラメータ:

simpleName - 単純名

戻り値:

生成した宣言

newAnnotation

<T extends Annotation> CtAnnotation<T> newAnnotation(String simpleName)

最小限の構造を持つCtAnnotationの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 宣言の型

パラメータ:

simpleName - 単純名

戻り値:

生成した宣言

newField

<T> CtField<T> newField(CtType<T> type,
                        String simpleName)

最小限の構造を持つCtFieldの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 生成する要素の型

パラメータ:

type - フィールドの型

simpleName - 単純名

戻り値:

生成した宣言

newEnumConstant

<T extends Enum<?>> CtEnumConstant<T> newEnumConstant(CtEnum<T> parent,
                                                      String simpleName)

最小限の構造を持つCtEnumConstantの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 生成する要素の型

パラメータ:

parent - 列挙型

simpleName - 単純名

戻り値:

生成した宣言

newInitializer

CtInitializer newInitializer()

最小限の構造を持つCtInitializerの宣言を新しく生成して返す。 この宣言は親を持たない。

戻り値:

生成した宣言

newMethod

<T> CtMethod<T> newMethod(CtType<T> returnType,
                          String simpleName)

最小限の構造を持つCtMethodの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 生成する要素の型

パラメータ:

returnType - 戻り値型

simpleName - 単純名

戻り値:

生成した宣言

newConstructor

<T> CtConstructor<T> newConstructor(CtDeclaredType<T> parent)

最小限の構造を持つCtConstructorの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 生成する要素の型

パラメータ:

parent - 宣言型

戻り値:

生成した宣言

newAnnotationElement

<T> CtAnnotationElement<T> newAnnotationElement(CtType<T> type,
                                                String simpleName)

最小限の構造を持つCtAnnotationElementの宣言を新しく生成して返す。 この宣言は親を持たない。

型パラメータ:

T - 生成する要素の型

パラメータ:

type - 要素が型

simpleName - 単純名

戻り値:

生成した宣言

newPackage

CtPackage newPackage(String simpleName)

指定の名前を持つパッケージ片の宣言を新しく生成して返す。 この宣言は親を持たない。

パラメータ:

simpleName - パッケージ片の名前

戻り値:

パッケージ片の宣言

borrow

DeclarationFactory borrow()

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

このツールを借りる。

定義:

インタフェース Tool 内の borrow

戻り値:

借りるツール