compact3

javax.tools

クラスForwardingJavaFileManager<M extends JavaFileManager>

java.lang.Object

javax.tools.ForwardingJavaFileManager<M>

型パラメータ:

M - このオブジェクトによって転送されるファイル・マネージャの種類

すべての実装されたインタフェース:

Closeable, Flushable, AutoCloseable, JavaFileManager, OptionChecker

public class ForwardingJavaFileManager<M extends JavaFileManager>
extends Object
implements JavaFileManager

指定されたファイル・マネージャに呼出しを転送します。このクラスのサブクラスは、これらのメソッドの一部をオーバーライドする可能性があります。また、追加のフィールドおよびメソッドを提供する可能性もあります。

導入されたバージョン:

1.6

ネストされたクラスのサマリー

インタフェース javax.tools.JavaFileManagerから継承されたネストされたクラス/インタフェース

JavaFileManager.Location

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected M	fileManager すべてのメソッドが委譲される、委譲先のファイル・マネージャです。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	ForwardingJavaFileManager(M fileManager) ForwardingJavaFileManagerの新しいインスタンスを生成します。

メソッドのサマリー

修飾子と型	メソッドと説明
void	close() このファイル・マネージャによって直接的または間接的に開かれたリソースがあれば、それを解放します。
void	flush() このファイル・マネージャによって直接的または間接的に開かれた出力用リソースがあれば、それをフラッシュします。
ClassLoader	getClassLoader(JavaFileManager.Location location) 指定された場所からプラグインをロードするクラス・ローダーを取得します。
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) 指定された場所にある、特定のパッケージ内の特定の相対名を表す入力用ファイル・オブジェクトを取得します。
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) 指定された場所にある、特定のパッケージ内の特定の相対名を表す出力用ファイル・オブジェクトを取得します。
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) 指定された場所にある、特定の種類の特定のクラスを表す入力用ファイル・オブジェクトを取得します。
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) 指定された場所にある、特定の種類の特定のクラスを表す出力用ファイル・オブジェクトを取得します。
boolean	handleOption(String current, Iterator<String> remaining) 1つのオプションを処理します。
boolean	hasLocation(JavaFileManager.Location location) このファイル・マネージャにとって既知の場所であるかどうかを判断します。
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject file) 場所に基づいてファイル・オブジェクトのバイナリ名を推測します。
boolean	isSameFile(FileObject a, FileObject b) 2つのファイル・オブジェクトを比較し、これらによって表される配下のオブジェクトが同じである場合はtrueを返します。
int	isSupportedOption(String option) 指定されたオプションがサポートされているかどうかを調べ、サポートされている場合はそのオプションがとる引数の数を特定します。
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) 指定の場所の指定の基準に一致するすべてのファイル・オブジェクトを一覧表示します。

クラス java.lang.Objectから継承されたメソッド

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

フィールドの詳細

fileManager

protected final M extends JavaFileManager fileManager

すべてのメソッドが委譲される、委譲先のファイル・マネージャです。

コンストラクタの詳細

ForwardingJavaFileManager

protected ForwardingJavaFileManager(M fileManager)

ForwardingJavaFileManagerの新しいインスタンスを生成します。

パラメータ:

fileManager - このファイル・マネージャに委譲される対象

メソッドの詳細

getClassLoader

public ClassLoader getClassLoader(JavaFileManager.Location location)

インタフェースからコピーされた説明: JavaFileManager

指定された場所からプラグインをロードするクラス・ローダーを取得します。たとえば、注釈プロセッサをロードするには、コンパイラは、ANNOTATION_PROCESSOR_PATHの場所のクラス・ローダーを要求します。

定義:

getClassLoader、インタフェース: JavaFileManager

パラメータ:

location - 場所

戻り値:

指定の場所のクラス・ローダー。指定の場所からプラグインをロードできない場合、または未知の場所が指定された場合はnull

例外:

SecurityException - 現在のセキュリティ・コンテキストでクラス・ローダーを作成できない場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

list

public Iterable<JavaFileObject> list(JavaFileManager.Location location,
                                     String packageName,
                                     Set<JavaFileObject.Kind> kinds,
                                     boolean recurse)
                              throws IOException

インタフェースからコピーされた説明: JavaFileManager

指定の場所の指定の基準に一致するすべてのファイル・オブジェクトを一覧表示します。再帰処理が有効になっている場合、「サブパッケージ」内のファイル・オブジェクトも一覧表示されます。

注: このファイル・マネージャにとって未知の場所が指定された場合も、nullが返されることはありません。また、例外が生成されることもありません。

定義:

list、インタフェース: JavaFileManager

パラメータ:

location - 場所

packageName - パッケージ名

kinds - これらの種類のオブジェクトのみ返す

recurse - trueの場合、「サブパッケージ」が含まれる

戻り値:

指定された基準に一致するファイル・オブジェクトのIterable

例外:

IOException - 入出力エラーが発生した場合、またはJavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

inferBinaryName

public String inferBinaryName(JavaFileManager.Location location,
                              JavaFileObject file)

インタフェースからコピーされた説明: JavaFileManager

場所に基づいてファイル・オブジェクトのバイナリ名を推測します。返されるバイナリ名は、『Java(tm)言語仕様』に従った有効なバイナリ名ではないことがあります。

定義:

inferBinaryName、インタフェース: JavaFileManager

パラメータ:

location - 場所

file - ファイル・オブジェクト

戻り値:

バイナリ名。指定された場所にファイル・オブジェクトが見つからない場合はnull

例外:

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

isSameFile

public boolean isSameFile(FileObject a,
                          FileObject b)

インタフェースからコピーされた説明: JavaFileManager

2つのファイル・オブジェクトを比較し、これらによって表される配下のオブジェクトが同じである場合はtrueを返します。

定義:

isSameFile、インタフェース: JavaFileManager

パラメータ:

a - ファイル・オブジェクト

b - ファイル・オブジェクト

戻り値:

指定されたファイル・オブジェクトによって表される配下のオブジェクトが同じである場合はtrue

例外:

IllegalArgumentException - いずれかの引数が別のファイル・マネージャで作成された引数であり、このファイル・マネージャが外部ファイル・オブジェクトをサポートしていない場合

handleOption

public boolean handleOption(String current,
                            Iterator<String> remaining)

インタフェースからコピーされた説明: JavaFileManager

1つのオプションを処理します。currentがこのファイル・マネージャのオプションである場合は、remainingからそのオプションに対するすべての引数を使用し、trueを返します。そうでない場合はfalseを返します。

定義:

handleOption、インタフェース: JavaFileManager

パラメータ:

current - 現在のオプション

remaining - 残りのオプション

戻り値:

このオプションがこのファイル・マネージャで処理された場合はtrue、そうでない場合はfalse

例外:

IllegalArgumentException - このファイル・マネージャに対するこのオプションが不正に使用された場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

hasLocation

public boolean hasLocation(JavaFileManager.Location location)

インタフェースからコピーされた説明: JavaFileManager

このファイル・マネージャにとって既知の場所であるかどうかを判断します。

定義:

hasLocation、インタフェース: JavaFileManager

パラメータ:

location - 場所

戻り値:

既知の場所である場合はtrue

isSupportedOption

public int isSupportedOption(String option)

インタフェースからコピーされた説明: OptionChecker

指定されたオプションがサポートされているかどうかを調べ、サポートされている場合はそのオプションがとる引数の数を特定します。

定義:

isSupportedOption、インタフェース: OptionChecker

パラメータ:

option - オプション

戻り値:

指定されたオプションがとる引数の数。そのオプションがサポートされていない場合は -1

getJavaFileForInput

public JavaFileObject getJavaFileForInput(JavaFileManager.Location location,
                                          String className,
                                          JavaFileObject.Kind kind)
                                   throws IOException

インタフェースからコピーされた説明: JavaFileManager

指定された場所にある、特定の種類の特定のクラスを表す入力用ファイル・オブジェクトを取得します。

定義:

getJavaFileForInput、インタフェース: JavaFileManager

パラメータ:

location - 場所

className - クラスの名前

kind - ファイルの種類。SOURCEまたはCLASSのいずれかである必要がある

戻り値:

ファイル・オブジェクト。ファイルが存在しない場合はnullが返される可能性がある

例外:

IllegalArgumentException - このファイル・マネージャにとって未知の場所が指定され、ファイル・マネージャが未知の場所をサポートしていない場合、またはファイルの種類が有効でない場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

IOException - 入出力エラーが発生した場合、またはJavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

getJavaFileForOutput

public JavaFileObject getJavaFileForOutput(JavaFileManager.Location location,
                                           String className,
                                           JavaFileObject.Kind kind,
                                           FileObject sibling)
                                    throws IOException

インタフェースからコピーされた説明: JavaFileManager

指定された場所にある、特定の種類の特定のクラスを表す出力用ファイル・オブジェクトを取得します。

このファイル・マネージャは、オプションとして、兄弟ウィジェットを出力先のヒントとして使用する可能性があります。このヒントの厳密なセマンティックスは指定されません。たとえばJDKコンパイラjavacは、クラス・ファイルの出力ディレクトリが指定されていない場合、ソース・ファイルと同じディレクトリにクラス・ファイルを配置します。この処理を簡便化するため、javacは、このメソッドを呼び出すとき、ソース・ファイルを兄弟ウィジェットとして指定することがあります。

定義:

getJavaFileForOutput、インタフェース: JavaFileManager

パラメータ:

location - 場所

className - クラスの名前

kind - ファイルの種類。SOURCEまたはCLASSのいずれかである必要がある

sibling - 配置のヒントとして使用されるファイル・オブジェクト。次も可: null

戻り値:

出力用ファイル・オブジェクト

例外:

IllegalArgumentException - このファイル・マネージャにとって未知の兄弟ウィジェットが指定された場合、このファイル・マネージャにとって未知の場所が指定され、ファイル・マネージャが未知の場所をサポートしていない場合、またはファイルの種類が有効でない場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

IOException - 入出力エラーが発生した場合、またはJavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

getFileForInput

public FileObject getFileForInput(JavaFileManager.Location location,
                                  String packageName,
                                  String relativeName)
                           throws IOException

インタフェースからコピーされた説明: JavaFileManager

指定された場所にある、特定のパッケージ内の特定の相対名を表す入力用ファイル・オブジェクトを取得します。

返されたオブジェクトがソースファイルまたはクラスファイルを表す場合、これはJavaFileObjectのインスタンスである必要があります。

非公式には、このメソッドで返されるファイル・オブジェクトは、場所、パッケージ名、および相対名を連結した場所にあります。たとえば、SOURCE_PATHの場所にある「com.sun.tools.javac」パッケージ内のプロパティ・ファイル「resources/compiler.properties」を探している場合、次のようにしてこのメソッドを呼び出すことができます。

getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

この呼出しがWindows上で実行され、SOURCE_PATHが"C:\Documents and Settings\UncleBob\src\share\classes"に設定されていた場合、有効な結果は、ファイル"C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties"を表すファイル・オブジェクトになります。

定義:

getFileForInput、インタフェース: JavaFileManager

パラメータ:

location - 場所

packageName - パッケージ名

relativeName - 相対名

戻り値:

ファイル・オブジェクト。ファイルが存在しない場合はnullが返される可能性がある

例外:

IllegalArgumentException - このファイル・マネージャにとって未知の場所が指定され、ファイル・マネージャが未知の場所をサポートしていない場合、またはrelativeNameが有効でない場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

IOException - 入出力エラーが発生した場合、またはJavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

getFileForOutput

public FileObject getFileForOutput(JavaFileManager.Location location,
                                   String packageName,
                                   String relativeName,
                                   FileObject sibling)
                            throws IOException

インタフェースからコピーされた説明: JavaFileManager

指定された場所にある、特定のパッケージ内の特定の相対名を表す出力用ファイル・オブジェクトを取得します。

このファイル・マネージャは、オプションとして、兄弟ウィジェットを出力先のヒントとして使用する可能性があります。このヒントの厳密なセマンティックスは指定されません。たとえばJDKコンパイラjavacは、クラス・ファイルの出力ディレクトリが指定されていない場合、ソース・ファイルと同じディレクトリにクラス・ファイルを配置します。この処理を簡便化するため、javacは、このメソッドを呼び出すとき、ソース・ファイルを兄弟ウィジェットとして指定することがあります。

返されたオブジェクトがソースファイルまたはクラスファイルを表す場合、これはJavaFileObjectのインスタンスである必要があります。

非公式には、このメソッドで返されるファイル・オブジェクトは、場所、パッケージ名、および相対名を連結した場所か、兄弟引数の次にあります。例については、getFileForInputを参照してください。

定義:

getFileForOutput、インタフェース: JavaFileManager

パラメータ:

location - 場所

packageName - パッケージ名

relativeName - 相対名

sibling - 配置のヒントとして使用されるファイル・オブジェクト。次も可: null

戻り値:

ファイル・オブジェクト

例外:

IllegalArgumentException - このファイル・マネージャにとって未知の兄弟ウィジェットが指定された場合、このファイル・マネージャにとって未知の場所が指定され、ファイル・マネージャが未知の場所をサポートしていない場合、またはrelativeNameが有効でない場合

IllegalStateException - JavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

IOException - 入出力エラーが発生した場合、またはJavaFileManager.close()が呼び出され、このファイル・マネージャを再度開くことができない場合

flush

public void flush()
           throws IOException

インタフェースからコピーされた説明: JavaFileManager

このファイル・マネージャによって直接的または間接的に開かれた出力用リソースがあれば、それをフラッシュします。閉じられたファイル・マネージャをフラッシュしても、効果はありません。

定義:

flush、インタフェース: Flushable

定義:

flush、インタフェース: JavaFileManager

例外:

IOException - 入出力エラーが発生した場合

関連項目:

JavaFileManager.close()

close

public void close()
           throws IOException

インタフェースからコピーされた説明: JavaFileManager

このファイル・マネージャによって直接的または間接的に開かれたリソースがあれば、それを解放します。すると、このファイル・マネージャが無効になり、その後このオブジェクト上で行われるメソッド呼び出しや、このオブジェクトを通して取得されるオブジェクトは、明示的に許可されていないかぎり未定義になります。ただし、すでに閉じられたファイル・マネージャを閉じても、効果はありません。

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

定義:

close、インタフェース: JavaFileManager

例外:

IOException - 入出力エラーが発生した場合

関連項目:

JavaFileManager.flush()