compact3

javax.tools

Interface StandardJavaFileManager

All Superinterfaces:

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

此文件管理器创建一个代表普通文件对象files ， zip file entries类似的基于文件系统的容器，或条目。 从实现此接口的文件管理器返回的任何文件对象必须遵守以下行为：

• 文件名不能是规范的。
• 对于表示普通文件的文件对象
  • 方法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()))

• URI从FileObject.toUri()返回
  • 必须是absolute （有一个模式），和
  • 必须有一个normalized path component ，可以解决没有任何进程特定的上下文，如当前目录（文件名必须是绝对的）。

根据这些规则，例如允许使用以下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

Nested Class Summary

Nested classes/interfaces inherited from interface javax.tools.JavaFileManager

JavaFileManager.Location

方法摘要

Modifier and Type	Method and Description
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) 比较两个文件对象，如果它们表示相同的规范文件，zip文件条目或任何基于文件系统的容器中的条目，则返回true。
void	setLocation(JavaFileManager.Location location, Iterable<? extends File> path) 将给定路径与给定位置相关联。

Methods inherited from interface javax.tools.JavaFileManager

close, flush, getClassLoader, getFileForInput, getFileForOutput, getJavaFileForInput, getJavaFileForOutput, handleOption, hasLocation, inferBinaryName, list

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

方法详细信息

isSameFile

boolean isSameFile(FileObject a,
                   FileObject b)

比较两个文件对象，如果它们表示相同的规范文件，zip文件条目或任何基于文件系统的容器中的条目，则返回true。

Specified by:

isSameFile在界面 JavaFileManager

参数

a - 一个文件对象

b - 一个文件对象

结果

如果给定的文件对象表示相同的规范文件或zip文件条目，则为true; 否则为假

异常

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 - 如果给定的数组包含空元素

getJavaFileObjectsFromStrings

Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names)

获取表示给定文件名的文件对象。

参数

names - 文件名列表

结果

文件对象的列表

异常

IllegalArgumentException - 如果文件名列表包含目录

getJavaFileObjects

Iterable<? extends JavaFileObject> getJavaFileObjects(String... names)

获取表示给定文件名的文件对象。 方便方法相当于：

  getJavaFileObjectsFromStrings(Arrays.asList(names)) 

参数

names - 文件名列表

结果

文件对象的列表

异常

IllegalArgumentException - 如果文件名数组包含目录

NullPointerException - 如果给定的数组包含空元素

setLocation

void setLocation(JavaFileManager.Location location,
                 Iterable<? extends File> path)
          throws IOException

将给定路径与给定位置相关联。 任何先前的值将被丢弃。

参数

location - 一个位置

path - 文件列表，如果 null使用此位置的默认路径

异常

IllegalArgumentException - 如果位置是输出位置，并且路径不包含正好一个元素

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