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

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

ImportBuilder, Tool

public interface CompilationUnitBuilder
extends Tool, ImportBuilder

CtCompilationUnitを生成する。

バージョン:

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

作成者:

Suguru ARAKAWA (Gluegent, Inc.)

メソッドの概要

ClientStorage	addClientStorage(Object key, ClientStorage storage) クライアントの追加情報を追加する。
CtImport	addImport(LtImportDeclaration target) インポート宣言を追加する。
CtDeclaredType<?>	addType(CtDeclaredType<?> declaration) 宣言された型を追加する。
CompilationUnitBuilder	borrow() このツールを借りる。
void	clear() この生成器を初期化する。
CtFile	getFile() このコンパイル単位を構成するファイルを返す。
CompilationUnitKind	getKind() コンパイル単位の種類を返す。
String	getName() このコンパイル単位の名前を返す。
CtPackage	getPackage() このコンパイル単位が属するパッケージを返す。
List<CtDeclaredType<?>>	getTypes() これまでに追加した宣言型の一覧を返す。
CtDeclaredType<?>	removeType(String simpleName) 宣言された型を削除する。
void	setFile(CtFile file) このコンパイル単位を構成するファイルを設定する。
void	setKind(CompilationUnitKind kind) コンパイル単位の種類を設定する。
void	setLocations(LocationManager locations) ソースコード上の位置に関する情報を設定する。
void	setName(String name) このコンパイル単位の名前を設定する。
CtPackage	setPackage(CtPackage declaration) パッケージ宣言を設定する。
CtPackage	setPackage(LtPackage declaration) パッケージ宣言を設定する。
CtCompilationUnit	toCompilationUnit() これまでの情報を元に、CtCompilationUnitを構築して返す。

インタフェース org.ashikunep.irenka.toolkit.ImportBuilder から継承されたメソッド

addImport, addImport, addImportOnDemand, addImportStatic, addImportStaticOnDemand, getImports, removeImport

メソッドの詳細

clear

void clear()

この生成器を初期化する。

toCompilationUnit

CtCompilationUnit toCompilationUnit()

これまでの情報を元に、CtCompilationUnitを構築して返す。

戻り値:

CtCompilationUnit

getFile

CtFile getFile()

このコンパイル単位を構成するファイルを返す。

戻り値:

このコンパイル単位を構成するファイル

setFile

void setFile(CtFile file)

このコンパイル単位を構成するファイルを設定する。

パラメータ:

file - 設定するファイル

getName

String getName()

このコンパイル単位の名前を返す。

戻り値:

コンパイル単位の名前

setName

void setName(String name)

このコンパイル単位の名前を設定する。

パラメータ:

name - 設定する名前

getKind

CompilationUnitKind getKind()

コンパイル単位の種類を返す。

戻り値:

コンパイル単位の種類

setKind

void setKind(CompilationUnitKind kind)

コンパイル単位の種類を設定する。

パラメータ:

kind - 設定するコンパイル単位の種類

getPackage

CtPackage getPackage()

このコンパイル単位が属するパッケージを返す。

戻り値:

属するパッケージ

getTypes

List<CtDeclaredType<?>> getTypes()

これまでに追加した宣言型の一覧を返す。

戻り値:

宣言型の一覧

setPackage

CtPackage setPackage(CtPackage declaration)

パッケージ宣言を設定する。 未設定の場合はデフォルトパッケージを利用する。

パラメータ:

declaration - パッケージ

戻り値:

実際に追加した宣言

setPackage

CtPackage setPackage(LtPackage declaration)

パッケージ宣言を設定する。 未設定の場合はデフォルトパッケージを利用する。

パラメータ:

declaration - パッケージ

戻り値:

実際に追加した宣言

addImport

CtImport addImport(LtImportDeclaration target)

インポート宣言を追加する。

パラメータ:

target - 追加する宣言

戻り値:

実際に追加した宣言

addType

CtDeclaredType<?> addType(CtDeclaredType<?> declaration)

宣言された型を追加する。 すでに同名の宣言型が存在する場合、古い宣言型は引数に指定された宣言型に置き換えられる。

パラメータ:

declaration - 追加する宣言型

戻り値:

置き換えられた型、存在しない場合はnull

例外:

IllegalArgumentException - パッケージ宣言が適切でない場合

関連項目:

setPackage(CtPackage)

removeType

CtDeclaredType<?> removeType(String simpleName)

宣言された型を削除する。

パラメータ:

simpleName - 宣言された型の単純名

戻り値:

削除された型、存在しない場合はnull

例外:

IllegalArgumentException - パッケージ宣言が適切でない場合

setLocations

void setLocations(LocationManager locations)

ソースコード上の位置に関する情報を設定する。

パラメータ:

locations - ソースコード上の位置に関する情報

addClientStorage

ClientStorage addClientStorage(Object key,
                               ClientStorage storage)

クライアントの追加情報を追加する。 ここで追加された情報は、#toCompilationUnit()が実行された際に、返されるオブジェクトに対して付与される。

パラメータ:

key - 追加するオブジェクトを取得するためのキー

storage - 追加するオブジェクト

戻り値:

実際に追加したオブジェクト

borrow

CompilationUnitBuilder borrow()

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

このツールを借りる。

定義:

インタフェース ImportBuilder 内の borrow

定義:

インタフェース Tool 内の borrow

戻り値:

借りるツール