方法详细信息

• createSourceFile

  JavaFileObject createSourceFile​(CharSequence name,
                                  Element... originatingElements)
                           throws IOException

  创建一个新的源文件并返回一个对象以允许写入它。 可以创建类型或包的源文件。 文件的名称和路径（相对于root output location for source files ）基于要在该文件中声明的项目的名称以及项目的指定模块（如果有）。 如果在单个文件（即单个编译单元）中声明了多个类型，则文件名应对应于主要顶级类型的名称（例如，公共名称）。

  还可以创建源文件以保存有关包的信息，包括包注释。 要为命名包创建源文件，请将name参数作为包的名称，后跟".package-info" ; 要为未命名的包创建源文件，请使用"package-info" 。

  可选模块名称以类型名称或包名称为前缀，并使用“ / ”字符分隔。 例如，要在模块foo为类型a.B创建源文件，请使用name参数"foo/a.B" 。

  如果没有给出显式模块前缀并且环境中支持模块，则推断出合适的模块。 如果无法推断出合适的模块，则抛出FilerException 。 实现可以使用关于注释处理工具的配置的信息作为推断的一部分。

  不支持在命名模块中或为命名模块中的未命名包创建源文件。

  API Note:

  使用特定charset来编码文件的内容，一个OutputStreamWriter与所选择的字符集可以从所创建的OutputStream从返回的对象。 如果返回的对象中的Writer直接用于写入，则其字符集由实现确定。 注释处理工具可以具有-encoding标志或用于指定此标志的类似选项; 否则，它通常是平台的默认编码。

  为避免后续错误，源文件的内容应与此次运行使用的source version兼容。

  Implementation Note:

  在参考实现中，如果注释处理工具正在处理单个模块M ，则M被用作在没有显式模块前缀的情况下创建的文件的模块。 如果该工具正在处理多个模块，并且Elements.getPackageElement(package-of(name))返回一个包，则拥有返回包的模块将用作目标模块。 如果使用上述规则无法确定目标模块，则可以使用单独的选项。

  参数

  name - 在此文件中声明的主体类型的规范（完全限定）名称或包名称，后跟包含信息文件的 ".package-info"

  originatingElements - 与此文件的创建有因果关联的类型或包或模块元素可能被省略或 null

  结果

  一个 JavaFileObject写入新的源文件

  异常

  FilerException - 如果已创建相同的路径名，则已创建相同的类型，否则该名称对于请求创建的实体无效，如果无法确定目标模块，目标模块是否可写，或者当环境不支持模块时指定模块。

  IOException - 如果无法创建文件

  See The Java™ Language Specification:

  7.3编译单位

• createClassFile

  JavaFileObject createClassFile​(CharSequence name,
                                 Element... originatingElements)
                          throws IOException

  创建一个新的类文件，并返回一个允许写入它的对象。 可以创建类型或包的类文件。 文件的名称和路径（相对于root output location for class files ）基于要声明的项目的名称以及项目的指定模块（如果有）。

  还可以创建类文件来保存有关包的信息，包括包注释。 要为命名包创建类文件，请将name参数作为包的名称，后跟".package-info" ; 不支持为未命名的包创建类文件。

  可选模块名称以类型名称或包名称为前缀，并使用“ / ”字符分隔。 例如，要在模块foo为类型a.B创建类文件，请使用name参数"foo/a.B" 。

  如果没有给出显式模块前缀并且环境中支持模块，则推断出合适的模块。 如果无法推断出合适的模块，则抛出FilerException 。 实现可以使用关于注释处理工具的配置的信息作为推断的一部分。

  不支持在命名模块中为未命名的包创建类文件。

  API Note:

  为避免后续错误，类文件的内容应与此运行使用的 source version兼容。

  Implementation Note:

  在参考实现中，如果注释处理工具正在处理单个模块M ，则M被用作在没有显式模块前缀的情况下创建的文件的模块。 如果该工具正在处理多个模块，并且Elements.getPackageElement(package-of(name))返回一个包，则拥有返回包的模块将用作目标模块。 如果使用上述规则无法确定目标模块，则可以使用单独的选项。

  参数

  name - 正在写入的类型的二进制名称或包名称，后跟包含信息文件的 ".package-info"

  originatingElements - 与此文件的创建有因果关联的类型或包或模块元素可能被省略或 null

  结果

  一个 JavaFileObject写入新的类文件

  异常

  FilerException - 如果已创建相同的路径名，则已创建相同的类型，名称对于类型无效，如果无法确定目标模块，目标模块是否不可写，或者何时指定了模块环境不支持模块。

  IOException - 如果无法创建文件

• createResource

  FileObject createResource​(JavaFileManager.Location location,
                            CharSequence moduleAndPkg,
                            CharSequence relativeName,
                            Element... originatingElements)
                     throws IOException

  创建用于写入的新辅助资源文件，并为其返回文件对象。 该文件可以与新创建的源文件，新创建的二进制文件或其他支持的位置一起定位。 必须支持位置CLASS_OUTPUT和SOURCE_OUTPUT 。 资源可以相对于某个模块和/或包（如源文件和类文件）命名，并从那里通过相对路径名来命名。 在宽松的意义上说，新文件的全名是串接location ， moduleAndPkg和relativeName 。 如果moduleAndPkg包含一个“ / ”字样，“前的前缀/ ”字就是模块名与“后的后缀/ ”字是软件包的名称。 包后缀可能为空。 如果moduleAndPkg不包含“ / ”字符，则整个参数将被解释为包名称。

  如果给定位置既不是module oriented location ，也不是output location containing multiple modules ，并且给出了显式模块前缀，则抛出FilerException 。

  如果给定位置是面向模块的位置，或者是包含多个模块的输出位置，并且没有给出显式模块前缀，则推断出合适的模块。 如果无法推断出合适的模块，则抛出FilerException 。 实现可以使用关于注释处理工具的配置的信息作为推断的一部分。

  通过此方法创建的文件不会注册用于注释处理，即使文件的完整路径名对应于新源文件或新类文件的完整路径名也是如此。

  Implementation Note:

  在参考实现中，如果注释处理工具正在处理单个模块M ，则M被用作在没有显式模块前缀的情况下创建的文件的模块。 如果该工具正在处理多个模块，并且Elements.getPackageElement(package-of(name))返回一个包，则拥有返回包的模块将用作目标模块。 如果使用上述规则无法确定目标模块，则可以使用单独的选项。

  参数

  location - 新文件的位置

  moduleAndPkg - 应该命名文件的模块和/或包，如果没有，则为空字符串

  relativeName - 文件的最终路径名组件

  originatingElements - 与此文件的创建因果关联的类型或包或模块元素可能被省略或 null

  结果

  一个 FileObject来编写新资源

  异常

  IOException - 如果无法创建文件

  FilerException - 如果已创建相同的路径名，如果无法确定目标模块，或者目标模块不可写，或者指定了显式目标模块且该位置不支持它。

  IllegalArgumentException - 对于不受支持的位置

  IllegalArgumentException - 如果 moduleAndPkg

  IllegalArgumentException - 如果 relativeName不是相对的

• getResource

  FileObject getResource​(JavaFileManager.Location location,
                         CharSequence moduleAndPkg,
                         CharSequence relativeName)
                  throws IOException

  返回用于读取现有资源的对象。 必须支持位置CLASS_OUTPUT和SOURCE_OUTPUT 。

  如果moduleAndPkg包含一个“ / ”字样，“前的前缀/ ”字就是模块名与“后的后缀/ ”字是软件包的名称。 包后缀可能为空; 但是，如果存在模块名称，则它必须是非空的。 如果moduleAndPkg不包含“ / ”字符，则整个参数将被解释为包名称。

  如果给定位置既不是module oriented location ，也不是output location containing multiple modules ，并且给出了显式模块前缀，则抛出FilerException 。

  如果给定位置是面向模块的位置，或者是包含多个模块的输出位置，并且没有给出显式模块前缀，则推断出合适的模块。 如果无法推断出合适的模块，则抛出FilerException 。 实现可以使用关于注释处理工具的配置的信息作为推断的一部分。

  Implementation Note:

  在参考实现中，如果注释处理工具正在处理单个模块M ，则M被用作用于在没有显式模块前缀的情况下读取的文件的模块。 如果该工具正在处理多个模块，并且Elements.getPackageElement(package-of(name))返回一个包，则拥有返回包的模块将用作源模块。 如果使用上述规则无法确定目标模块，则可以使用单独的选项。

  参数

  location - 文件的位置

  moduleAndPkg - 应搜索文件的模块和/或包，如果没有，则为空字符串

  relativeName - 文件的最终路径名组件

  结果

  一个读取文件的对象

  异常

  FilerException - 如果已经打开了相同的路径名进行写入，如果无法确定源模块，或者目标模块不可写，或者指定了显式目标模块且该位置不支持它。

  IOException - 如果无法打开文件

  IllegalArgumentException - 对于不受支持的位置

  IllegalArgumentException - 如果 moduleAndPkg

  IllegalArgumentException - 如果 relativeName不是相对的