JavaFileManager (Java Platform SE 8 )

All Superinterfaces:

AutoCloseable， Closeable， Flushable， OptionChecker

All Known Subinterfaces:

StandardJavaFileManager

所有已知实现类：

ForwardingJavaFileManager
```
public interface JavaFileManager
extends Closeable, Flushable, OptionChecker
```
文件管理工具的操作™java编程语言的源文件和类文件。在这种情况下，文件意味着一个常规文件和其他数据源的抽象。
构建新的javafileobjects时，档案管理员必须确定在哪里创建。例如，如果一个文件管理器管理一个文件系统上的常规文件，它将最有可能有一个当前/工作目录作为默认位置时，创建或查找文件。可以向一个文件管理器提供一些提示，以在哪里创建文件。任何文件管理器可能会选择忽略这些提示。

在这个接口使用类名称的一些方法。类的名字必须在java虚拟机内部形成完全合格的类和接口名称。为了方便“，”和“/”是可以互换的。内部形式是在The Java™ Virtual Machine Specification四章定义。

Discussion: this means that the names "java/lang.package-info", "java/lang/package-info", "java.lang.package-info", are valid and equivalent. Compare to binary name as defined in The Java™ Language Specification, section 13.1 "The Form of a Binary".

名称是显着的情况下。所有的名字都应该视为区分大小写。例如，一些文件系统具有大小写不区分大小写的文件名。代表该文件的对象应该采用File.getCanonicalFile()或类似方法保存情况。如果系统没有注意到，文件对象必须使用其他方法来保存情况。

相对名称：在这个接口中的一些方法使用的相对名称。一个相对的名称是一个非空的，非空序列的路径段由“/”分隔。“或”“是无效的路径段。一个有效的相对名称必须匹配RFC 3986“路径根”的规则，部分 3.3。非正式地说，这应该是真的：
```
URI。create（relativename）。z-d386c3c4-8a08-4677-9d1d- bdedfdc4a5f4()。z-269e02c1-86d4-44c7-b526- b458a7a9e47c()等于（relativename）。
```
在这个接口的所有方法可能引发SecurityException。

此接口的一个对象不需要支持多线程访问，也就是说，要同步。然而，它必须支持此对象创建的不同的文件对象的并发访问。

注：实现这一要求的后果是，一个平凡的实现输出到JarOutputStream不是充分实现。这是，而不是创建一个对象，返回jaroutputstream直接的内容必须被缓存到关闭，然后写入jaroutputstream。

除非明确允许，在这个接口的所有方法可能如果null论点抛出一个NullPointerException。
从以下版本开始：

一点六

另请参见：

JavaFileObject， FileObject

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`JavaFileManager.Location` 文件对象位置的接口。

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`void`	`close()` 释放由该文件管理器直接或间接打开的任何资源。
`void`	`flush()` 刷新任何资源打开这个文件管理器直接或间接输出。
`ClassLoader`	`getClassLoader(JavaFileManager.Location location)` 从给定的位置获取加载插件的类加载程序。
`FileObject`	`getFileForInput(JavaFileManager.Location location, String packageName, String relativeName)` 获取输入表示指定的 relative name在指定的包在给定位置的 file object。
`FileObject`	`getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling)` 获取输出表示指定的 relative name在指定的包在给定位置的 file object。
`JavaFileObject`	`getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind)` 获取输入表示指定类在给定的位置指定的一种 file object。
`JavaFileObject`	`getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling)` 获取输出表示指定类在给定的位置指定的一种 file object。
`boolean`	`handleOption(String current, Iterator<String> remaining)` 处理一个选项。
`boolean`	`hasLocation(JavaFileManager.Location location)` 确定是否已知此文件管理器的位置。
`String`	`inferBinaryName(JavaFileManager.Location location, JavaFileObject file)` 推导了基于位置的文件对象的二进制名称。
`boolean`	`isSameFile(FileObject a, FileObject b)` 比较两个文件对象并返回真，如果它们表示相同的底层对象。
`Iterable<JavaFileObject>`	`list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse)` 列出在给定位置中匹配给定的标准的所有文件对象。

Methods inherited from interface javax.tools.OptionChecker
isSupportedOption

- 方法详细信息
  - getClassLoader
```
ClassLoader getClassLoader(JavaFileManager.Location location)
```
    从给定的位置获取加载插件的类加载程序。例如，加载注释处理器，编译器将请求 ANNOTATION_PROCESSOR_PATH位置的类加载器。
    
    参数
    
    location -位置
    
    结果
    
    对于给定的位置的类装载器；或 null如果位置不知道加载插件从给定的位置被禁用或
    
    异常
    
    SecurityException -如果一个类装载器不能在当前安全上下文创建
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - list
```
Iterable<JavaFileObject> list(JavaFileManager.Location location,
                              String packageName,
                              Set<JavaFileObject.Kind> kinds,
                              boolean recurse)
                       throws IOException
```
    列出在给定位置中匹配给定的标准的所有文件对象。列表文件对象在“分包”如果递归是真实的。
    注意：即使给定的位置是这个文件管理器未知，它可能不会返回null。此外，一个未知的位置可能不会导致异常。
    
    参数
    
    location -位置
    
    packageName -包的名称
    
    kinds返回对象的只有这些
    
    recurse -如果真有“分包”
    
    结果
    
    文件对象匹配给定一个标准
    
    异常
    
    IOException如果发生I/O错误，或者如果 close()被称为这个文件管理器无法打开
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - inferBinaryName
```
String inferBinaryName(JavaFileManager.Location location,
                       JavaFileObject file)
```
    推导了基于位置的文件对象的二进制名称。二进制名称返回的可能不是一个有效的二进制名称根据 The Java™ Language Specification。
    
    参数
    
    location -位置
    
    file -一个文件对象
    
    结果
    
    一个二进制文件的名称或 null对象不在给定的位置找到
    
    异常
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - isSameFile
```
boolean isSameFile(FileObject a,
                   FileObject b)
```
    比较两个文件对象并返回真，如果它们表示相同的底层对象。
    
    参数
    
    a -一个文件对象
    
    b -一个文件对象
    
    结果
    
    如果给定的文件对象表示相同的基础对象，则为
    
    异常
    
    IllegalArgumentException -如果任何观点都是与另一个文件管理器和文件管理器创建的不支持外国的文件对象
  - handleOption
```
boolean handleOption(String current,
                     Iterator<String> remaining)
```
    处理一个选项。如果 current是选择这个文件管理器会消耗任何论点从 remaining选项，返回true，否则返回false。
    
    参数
    
    current电流选择
    
    remaining -其余选项
    
    结果
    
    如果此选项由此文件管理器处理，则为假，否则为
    
    异常
    
    IllegalArgumentException -如果这个选项这个文件管理器使用不当
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - hasLocation
```
boolean hasLocation(JavaFileManager.Location location)
```
    确定是否已知此文件管理器的位置。
    
    参数
    
    location -位置
    
    结果
    
    如果位置是已知的
  - getJavaFileForInput
```
JavaFileObject getJavaFileForInput(JavaFileManager.Location location,
                                   String className,
                                   JavaFileObject.Kind kind)
                            throws IOException
```
    获取输入表示指定类在给定的位置指定的一种 file object。
    
    参数
    
    location -位置
    
    className -类的名称
    
    kind -文件类型，必须是一个 SOURCE或 CLASS
    
    结果
    
    一个文件对象，可能会返回 null如果文件不存在
    
    异常
    
    IllegalArgumentException如果位置不知道这个文件管理器和文件管理器不支持未知地点，或者是无效的
    
    IOException如果发生I/O错误，或者如果 close()被称为这个文件管理器无法打开
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - getJavaFileForOutput
```
JavaFileObject getJavaFileForOutput(JavaFileManager.Location location,
                                    String className,
                                    JavaFileObject.Kind kind,
                                    FileObject sibling)
                             throws IOException
```
    获取输出表示指定类在给定的位置指定的一种 file object。
    可选地，这个文件管理器可能会考虑该兄弟姐妹作为一个提示，用于在哪里放置输出。这个提示的确切语义是未指定的。JDK的编译器javac，例如，将类文件在同一目录，源文件，除非提供一个类文件输出目录。为了促进这一行为，javac可能提供源文件作为兄弟时调用此方法。
    
    参数
    
    location -位置
    
    className -类的名称
    
    kind -文件类型，必须是一个 SOURCE或 CLASS
    
    sibling -一个文件作为提示可能 null安置；
    
    结果
    
    输出的文件对象
    
    异常
    
    IllegalArgumentException如果兄弟不知道这个文件管理器，或者如果位置是不知道这个文件管理器和文件管理器不支持未知地点，或者是无效的
    
    IOException如果发生I/O错误，或者如果 close()被称为这个文件管理器无法打开
    
    IllegalStateException - close()被称为这个文件管理器无法打开
  - getFileForInput
```
FileObject getFileForInput(JavaFileManager.Location location,
                           String packageName,
                           String relativeName)
                    throws IOException
```
    获取一个 file object输入表示指定的 relative name在指定的包在给定的位置。
    如果返回的对象是一个source或class文件，它必须是JavaFileObject实例。
    
    非正式的文件，此方法返回的对象是位于的位置，包名称的连接，和相对的名字。例如，查找文件的属性“资源/编译器。属性”包中的“COM。太阳。工具。javac”在SOURCE_PATH位置，这种方法可以称为像这样：
```
getfileforinput（source_path，“COM。太阳。工具。javac”、“资源/编译器。属性”）；
```
    如果调用执行的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"文件对象。
    参数
    
    location -位置
    
    packageName -包的名称
    
    relativeName -相关名称
    
    结果
    
    一个文件对象，可能会返回 null如果文件不存在
    
    异常
    
    IllegalArgumentException如果位置不知道这个文件管理器和文件管理器不支持未知地点，或者如果 relativeName无效
    
    IOException如果发生I/O错误，或者如果 close()被称为这个文件管理器无法打开
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - getFileForOutput
```
FileObject getFileForOutput(JavaFileManager.Location location,
                            String packageName,
                            String relativeName,
                            FileObject sibling)
                     throws IOException
```
    获取输出表示指定的 relative name在指定的包在给定位置的 file object。
    可选地，这个文件管理器可能会考虑该兄弟姐妹作为一个提示，用于在哪里放置输出。这个提示的确切语义是未指定的。JDK的编译器javac，例如，将类文件在同一目录，源文件，除非提供一个类文件输出目录。为了促进这一行为，javac可能提供源文件作为兄弟时调用此方法。
    
    如果返回的对象是一个source或class文件，它必须是JavaFileObject实例。
    
    非正式的文件，此方法返回的对象是位于的位置，包名称的连接，和相关的名称或旁边的兄弟的说法。看到一个例子getFileForInput。
    
    参数
    
    location -位置
    
    packageName -包的名称
    
    relativeName -相关名称
    
    sibling -一个文件作为提示可能 null安置；
    
    结果
    
    一个文件对象
    
    异常
    
    IllegalArgumentException如果兄弟不知道这个文件管理器，或者如果位置是不知道这个文件管理器和文件管理器不支持未知地点，或者如果 relativeName无效
    
    IOException如果发生I/O错误，或者如果 close()被称为这个文件管理器无法打开
    
    IllegalStateException -如果 close()被称为这个文件管理器无法打开
  - flush
```
void flush()
    throws IOException
```
    刷新任何资源打开这个文件管理器直接或间接输出。Flushing一个封闭的文件管理器没有效果。
    
    Specified by:
    
    flush 接口 Flushable
    
    异常
    
    IOException如果发生I/O错误
    
    另请参见：
    
    close()
  - close
```
void close()
    throws IOException
```
    释放由该文件管理器直接或间接打开的任何资源。这可能会使这个文件管理器无效，并且随后调用此对象的方法或通过此对象获得的任何对象的影响是不确定的，除非明确允许。然而，关闭已关闭的文件管理器没有任何效果。
    
    Specified by:
    
    close 接口 AutoCloseable
    
    Specified by:
    
    close 接口 Closeable
    
    异常
    
    IOException如果发生I/O错误
    
    另请参见：
    
    flush()

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Interface JavaFileManager

Nested Class Summary

方法摘要

Methods inherited from interface javax.tools.OptionChecker

方法详细信息

getClassLoader

list

inferBinaryName

isSameFile

handleOption

hasLocation

getJavaFileForInput

getJavaFileForOutput

getFileForInput

getFileForOutput

flush

close