既知のすべての実装クラス:: DocumentationTool.Location, StandardLocation

含まれているインタフェース:: JavaFileManager

public static interface JavaFileManager.Location

ファイル・オブジェクトの場所のインタフェースです。ファイル・マネージャで、ファイル・オブジェクトの配置場所を決定したり、ファイル・オブジェクトを検索したりするとき使用します。

非公式に、Locationは、デフォルトのファイル・システムを使用するコマンドライン・ツールで使用されるクラス・パスやモジュール・パスなどの"検索パス"に対応します。

一部のロケーションは、通常、ツールが読み取るファイルを検索できるロケーションを識別するために使用されます。その他のロケーションは、通常、ツールがファイルを書き込むことができるロケーションを識別するために使用されます。ファイルの読取りロケーションを識別するためにロケーションが使用されている場合、これらのファイルは単純なpackage/class階層に編成できます: そのようなロケーションはpackage-orientedと記述されています。または、ファイルをmodule/package/class階層に編成することもできます: そのようなロケーションはmodule-orientedと記述されます。ツールがファイルを書き込むことができるロケーションを識別するためにロケーションが通常使用される場合、それらのファイルの編成方法を指定するためにファイルを書き込むツールによって異なります。

JavaFileManager.getJavaFileForInput(javax.tools.JavaFileManager.Location, java.lang.String, javax.tools.JavaFileObject.Kind)やJavaFileManager.list(javax.tools.JavaFileManager.Location, java.lang.String, java.util.Set<javax.tools.JavaFileObject.Kind>, boolean)などのメソッドを使用して、パッケージ指向のロケーションでクラスにアクセスできます。モジュール指向のロケーションでクラスを直接リストすることはできません。かわりに、JavaFileManager.getLocationForModule(javax.tools.JavaFileManager.Location, java.lang.String)やJavaFileManager.listLocationsForModules(javax.tools.JavaFileManager.Location)などのメソッドを使用して、特定のモジュールのパッケージ指向のロケーションを取得できます。

メソッドのサマリー

修飾子と型

メソッド

説明

String

getName()

このロケーションの名前を返します。

default boolean

isModuleOrientedLocation()

このロケーションがモジュール指向のロケーションであり、したがって、package/class階層内のクラスを含むパッケージ指向のロケーションと比較して、module/package/class階層内のクラスを含めることが想定されるかどうかを示します。

boolean

isOutputLocation()

これが出力場所かどうかを判定します。

メソッドの詳細
- getName
  
  String getName()
  
  このロケーションの名前を返します。
  
  戻り値:
  
  名前
- isOutputLocation
  
  boolean isOutputLocation()
  
  これが出力場所かどうかを判定します。出力場所とは、通常出力に使用される場所のことです。
  
  APIのノート:
  
  出力ロケーションは、パッケージ指向の組織またはモジュール指向の組織でファイルを書き込むために使用できます。
  
  戻り値:
  
  これが出力場所である場合はtrue、そうでない場合はfalse
- isModuleOrientedLocation
  
  default boolean isModuleOrientedLocation()
  
  このロケーションがモジュール指向のロケーションであり、したがって、package/class階層内のクラスを含むパッケージ指向のロケーションと比較して、module/package/class階層内のクラスを含めることが想定されるかどうかを示します。出力ロケーションの場合、このメソッドの結果は未定義です。
  
  実装上のノート:
  
  この実装では、名前に"MODULE"という単語が含まれている場合はtrueを返します。
  
  戻り値:
  
  このロケーションにモジュールが含まれると予想される場合はtrue
  
  導入されたバージョン:
  
  9

インタフェースJavaFileManager.Location

メソッドのサマリー

メソッドの詳細

getName

isOutputLocation

isModuleOrientedLocation