javax.tools

インタフェース StandardJavaFileManager

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

AutoCloseable, Closeable, Flushable, JavaFileManager, OptionChecker

public interface StandardJavaFileManager
extends JavaFileManager

java.io.File に基づいたファイルマネージャーです。このクラスのインスタンスを取得するには、通常、getStandardFileManager を使用します。次に例を示します。

   JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
   DiagnosticCollector<JavaFileObject> diagnostics =
       new DiagnosticCollector<JavaFileObject>();
   StandardJavaFileManager fm = compiler.getStandardFileManager(diagnostics, null, null);
 

このファイルマネージャーは、通常のファイル、zip ファイルエントリ、または同様のファイルシステムに基づくコンテナ内のエントリを表すファイルオブジェクトを作成します。このインタフェースを実装しているファイルマネージャーから返されるファイルオブジェクトは、次の動作に従う必要があります。

• ファイル名は正規のものである必要はありません。
• 通常のファイルを表すファイルオブジェクトの場合は次のようになります。
  • メソッド FileObject.delete() は File.delete() と同等です。
  • メソッド FileObject.getLastModified() は File.lastModified() と同等です。
  • FileObject.getCharContent(boolean)、FileObject.openInputStream()、および FileObject.openReader(boolean) の各メソッドは、次に示すものが成功した場合に成功する必要がある (エンコーディングの問題は無視)。

    new FileInputStream(new File(fileObject.toUri()))

  • FileObject.openOutputStream() および FileObject.openWriter() の各メソッドは、次に示すものが成功した場合に成功する必要がある (エンコーディングの問題は無視)。

    new FileOutputStream(new File(fileObject.toUri()))

• FileObject.toUri() から返される URI は次のようになる必要があります。
  • 絶対的である (スキーマを持つ)。
  • プロセス固有のコンテキスト (現在のディレクトリなど) なしで解決できる標準化されたパスコンポーネントを持つ (ファイル名は絶対的である必要がある)。

これらの規則に従うと、たとえば次のようになります。

• file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java
• jar:///C:/Documents%20and%20Settings/UncleBob/lib/vendorA.jar!com/vendora/LibraryClass.class

次のようにはなりません (括弧内は理由)。

• file:BobsApp/Test.java (ファイル名が相対的で、現在のディレクトリに依存している)
• jar:lib/vendorA.jar!com/vendora/LibraryClass.class (! のあとの構成要素は正しいが、パスの前半が現在のディレクトリに依存している)
• Test.java (この URI は現在のディレクトリに依存しており、スキーマを持たない)
• jar:///C:/Documents%20and%20Settings/UncleBob/BobsApp/../lib/vendorA.jar!com/vendora/LibraryClass.class (パスが標準化されていない)

導入されたバージョン:

1.6

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

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

JavaFileManager.Location

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Iterable<? extends JavaFileObject>	getJavaFileObjects(File... files) 指定されたファイルを表すファイルオブジェクトを取得します。
Iterable<? extends JavaFileObject>	getJavaFileObjects(String... names) 指定されたファイル名を表すファイルオブジェクトを取得します。
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromFiles(Iterable<? extends File> files) 指定されたファイルを表すファイルオブジェクトを取得します。
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromStrings(Iterable<String> names) 指定されたファイル名を表すファイルオブジェクトを取得します。
Iterable<? extends File>	getLocation(JavaFileManager.Location location) 指定された場所に関連付けられているパスを取得します。
boolean	isSameFile(FileObject a, FileObject b) 2 つのファイルオブジェクトを比較し、それらが同一の正規のファイル、zip ファイルエントリ、またはファイルシステムに基づくコンテナ内のエントリを表している場合は true を返します。
void	setLocation(JavaFileManager.Location location, Iterable<? extends File> path) 指定されたパスと指定された場所を関連付けます。

インタフェース javax.tools.JavaFileManager から継承されたメソッド

close, flush, getClassLoader, getFileForInput, getFileForOutput, getJavaFileForInput, getJavaFileForOutput, handleOption, hasLocation, inferBinaryName, list

インタフェース javax.tools.OptionChecker から継承されたメソッド

isSupportedOption

メソッドの詳細

isSameFile

boolean isSameFile(FileObject a,
                 FileObject b)

2 つのファイルオブジェクトを比較し、それらが同一の正規のファイル、zip ファイルエントリ、またはファイルシステムに基づくコンテナ内のエントリを表している場合は true を返します。

定義:

isSameFile、インタフェース: JavaFileManager

パラメータ:

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

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

戻り値:

指定されたファイルオブジェクトが同一の正規のファイルまたは zip ファイルエントリを表す場合は true、そうでない場合は false

例外:

IllegalArgumentException - 一方の引数が別のファイルマネージャー実装で作成された場合

getJavaFileObjectsFromFiles

Iterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files)

指定されたファイルを表すファイルオブジェクトを取得します。

パラメータ:

files - ファイルのリスト

戻り値:

ファイルオブジェクトのリスト

例外:

IllegalArgumentException - ファイルのリストにディレクトリが含まれる場合

getJavaFileObjects

Iterable<? extends JavaFileObject> getJavaFileObjects(File... files)

指定されたファイルを表すファイルオブジェクトを取得します。同等の簡易メソッドは、次のとおりです。

     getJavaFileObjectsFromFiles(Arrays.asList(files))
 

パラメータ:

files - ファイルの配列

戻り値:

ファイルオブジェクトのリスト

例外:

IllegalArgumentException - ファイルの配列にディレクトリが含まれる場合

NullPointerException - 指定された配列に null 要素が含まれる場合

getJavaFileObjectsFromStrings

Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names)

指定されたファイル名を表すファイルオブジェクトを取得します。

パラメータ:

names - ファイル名のリスト

戻り値:

ファイルオブジェクトのリスト

例外:

IllegalArgumentException - ファイル名のリストにディレクトリが含まれる場合

getJavaFileObjects

Iterable<? extends JavaFileObject> getJavaFileObjects(String... names)

指定されたファイル名を表すファイルオブジェクトを取得します。同等の簡易メソッドは、次のとおりです。

     getJavaFileObjectsFromStrings(Arrays.asList(names))
 

パラメータ:

names - ファイル名のリスト

戻り値:

ファイルオブジェクトのリスト

例外:

IllegalArgumentException - ファイル名の配列にディレクトリが含まれる場合

NullPointerException - 指定された配列に null 要素が含まれる場合

setLocation

void setLocation(JavaFileManager.Location location,
               Iterable<? extends File> path)
                 throws IOException

指定されたパスと指定された場所を関連付けます。以前の値はすべて破棄されます。

パラメータ:

location - 場所

path - ファイルのリスト。null の場合、この場所のデフォルトのパスを使用

例外:

IllegalArgumentException - 場所が出力場所であり、パスに含まれる要素が厳密に 1 個でない場合

IOException - 場所が出力場所であり、パスが既存のディレクトリを表していない場合

関連項目:

getLocation(javax.tools.JavaFileManager.Location)

getLocation

Iterable<? extends File> getLocation(JavaFileManager.Location location)

指定された場所に関連付けられているパスを取得します。

パラメータ:

location - 場所

戻り値:

ファイルのリスト。この場所にパスが関連付けられていない場合は null

関連項目:

setLocation(javax.tools.JavaFileManager.Location, java.lang.Iterable<? extends java.io.File>)