compact3

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>)