モジュール java.compiler
パッケージ javax.tools

クラスForwardingJavaFileManager<M extends JavaFileManager>

  • 型パラメータ:
    M - このオブジェクトによって転送されるファイル・マネージャの種類
    すべての実装されたインタフェース:
    Closeable, Flushable, AutoCloseable, JavaFileManager, OptionChecker
    public class ForwardingJavaFileManager<M extends JavaFileManager>
extends Object
implements JavaFileManager
    指定されたファイル・マネージャに呼出しを転送します。 このクラスのサブクラスは、これらのメソッドの一部をオーバーライドする可能性があります。また、追加のフィールドおよびメソッドを提供する可能性もあります。
    導入されたバージョン:
    1.6

    • フィールドの詳細

      • 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™言語仕様』に従った有効なバイナリ名ではないことがあります。
        定義:
        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()が呼び出され、このファイル・マネージャを再度開くことができない場合

      • 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()が呼び出され、このファイル・マネージャを再度開くことができない場合

      • getLocationForModule

        public JavaFileManager.Location getLocationForModule​(JavaFileManager.Location location,
                                                     String moduleName)
                                              throws IOException
        インタフェースからコピーされた説明: JavaFileManager
        ロケーション内の名前付きモジュールの場所を取得します。モジュール指向の場所または出力場所のいずれかです。 指定された場所が出力場所である場合、またはパッケージ指向の場所である場合、結果は出力場所になります。
        定義:
        インタフェースJavaFileManagerのgetLocationForModule
        パラメータ:
        location - モジュール指向の場所
        moduleName - 検出されるモジュールの名前
        戻り値:
        指定されたモジュールの場所
        例外:
        IOException - 入出力エラーが発生した場合
        導入されたバージョン:
        9

      • getLocationForModule

        public JavaFileManager.Location getLocationForModule​(JavaFileManager.Location location,
                                                     JavaFileObject fo)
                                              throws IOException
        インタフェースからコピーされた説明: JavaFileManager
        場所内で検出される特定のファイルを含むモジュールの場所(モジュール指向の場所または出力場所)を取得します。 指定された場所が出力場所である場合、またはパッケージ指向の場所である場合、結果は出力場所になります。
        定義:
        インタフェースJavaFileManagerのgetLocationForModule
        パラメータ:
        location - モジュール指向の場所
        fo - ファイル
        戻り値:
        ファイルを含むモジュール
        例外:
        IOException - 入出力エラーが発生した場合
        導入されたバージョン:
        9

      • getServiceLoader

        public <S> ServiceLoader<S> getServiceLoader​(JavaFileManager.Location location,
                                             Class<S> service)
                                      throws IOException
        インタフェースからコピーされた説明: JavaFileManager
        特定の場所から特定のサービス・クラスのサービス・ローダーを取得します。 ロケーションがモジュール指向の場所である場合、サービス・ローダーは、その場所にあるモジュールのサービス宣言を使用します。 それ以外の場合、サービス・ローダーはパッケージ指向の場所を使用して作成され、その場合、サービスはMETA-INF/servicesのプロバイダ構成ファイルを使用して決定されます。
        定義:
        インタフェースJavaFileManagerのgetServiceLoader
        型パラメータ:
        S - サービス・クラス
        パラメータ:
        location - モジュール指向の場所
        service - サービス・クラスのClassオブジェクト
        戻り値:
        指定されたサービス・クラスのサービス・ローダー
        例外:
        IOException - 入出力エラーが発生した場合
        導入されたバージョン:
        9

      • inferModuleName

        public String inferModuleName​(JavaFileManager.Location location)
                       throws IOException
        インタフェースからコピーされた説明: JavaFileManager
        getLocationForModuleまたはlistModuleLocationsによって戻される、モジュールの名前をその場所から推測します。
        定義:
        インタフェースJavaFileManagerのinferModuleName
        パラメータ:
        location - モジュールを表すパッケージ指向の場所
        戻り値:
        モジュールの名前
        例外:
        IOException - 入出力エラーが発生した場合
        導入されたバージョン:
        9

      • listLocationsForModules

        public Iterable<Set<JavaFileManager.Location>> listLocationsForModules​(JavaFileManager.Location location)
                                                                throws IOException
        インタフェースからコピーされた説明: JavaFileManager
        モジュール指向の場所または出力場所にあるすべてのモジュールの場所を一覧表示します。 指定された場所が出力の場合、またはパッケージ指向の場所の場合、返される場所は出力場所になります。
        定義:
        インタフェースJavaFileManagerのlistLocationsForModules
        パラメータ:
        location - モジュールをリストするモジュール指向の場所
        戻り値:
        モジュールを含む一連の位置
        例外:
        IOException - 入出力エラーが発生した場合
        導入されたバージョン:
        9

      • contains

        public boolean contains​(JavaFileManager.Location location,
                        FileObject fo)
                 throws IOException
        インタフェースからコピーされた説明: JavaFileManager
        指定されたファイルオブジェクトが指定された場所に「含まれている」かどうかを決定します。

        パッケージ指向の場所では、packageNameおよびrelativeNameの値が存在する場合に、次の呼出しのいずれかがsameファイル・オブジェクトを返すように、ファイル・オブジェクトが場所に含まれます。 

             getFileForInput(location, packageName, relativeName)
     getFileForOutput(location, packageName, relativeName, null)

        モジュール指向の場所の場合、コールによって取得できるモジュールが存在する場合は、その場所にファイル・オブジェクトが含まれます。 

             getLocationForModule(location, moduleName)
        ファイル・オブジェクトが、そのモジュールの(パッケージ指向)場所に含まれるようにします。

        定義:
        インタフェースJavaFileManagerのcontains
        パラメータ:
        location - 場所
        fo - ファイル・オブジェクト
        戻り値:
        ファイルが場所に含まれているかどうか
        例外:
        IOException - 結果の決定に問題がある場合
        導入されたバージョン:
        9