JavaFileManager JDK 1.6)

Description

public interface JavaFileManager

File manager for tools operating on Java™ programming language source and class files.

File manager for tools operating on Java™ programming language source and class files. In this context, file means an abstraction of regular files and other sources of data.

When constructing new JavaFileObjects, the file manager must determine where to create them. For example, if a file manager manages regular files on a file system, it would most likely have a current/working directory to use as default location when creating or finding files. A number of hints can be provided to a file manager as to where to create files. Any file manager might choose to ignore these hints.

Some methods in this interface use class names. Such class names must be given in the Java Virtual Machine internal form of fully qualified class and interface names. For convenience '.' and '/' are interchangeable. The internal form is defined in chapter four of 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 (JLS) section 13.1 "The Form of a Binary".

The case of names is significant. All names should be treated as case-sensitive. For example, some file systems have case-insensitive, case-aware file names. File objects representing such files should take care to preserve case by using File.getCanonicalFile() or similar means. If the system is not case-aware, file objects must use other means to preserve case.

Relative names: some methods in this interface use relative names. A relative name is a non-null, non-empty sequence of path segments separated by '/'. '.' or '..' are invalid path segments. A valid relative name must match the "path-rootless" rule of RFC 3986, section 3.3. Informally, this should be true:

  URI.create(relativeName).normalize().getPath().equals(relativeName)

All methods in this interface might throw a SecurityException.

An object of this interface is not required to support multi-threaded access, that is, be synchronized. However, it must support concurrent access to different file objects created by this object.

Implementation note: a consequence of this requirement is that a trivial implementation of output to a JarOutputStream is not a sufficient implementation. That is, rather than creating a JavaFileObject that returns the JarOutputStream directly, the contents must be cached until closed and then written to the JarOutputStream.

Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a null argument.

See also: JavaFileObject FileObject

Methods

Hide/Show inherited methods

public void close () throws IOException [Specified in Closeable]

Releases any resources opened by this file manager directly or indirectly.

public void flush () throws IOException [Specified in Flushable]

Flushes any resources opened for output by this file manager directly or indirectly.

public ClassLoader getClassLoader (Location location)

Gets a class loader for loading plug-ins from the given location.

public FileObject getFileForInput (Location location, String packageName, String relativeName) throws IOException

Gets a file object for input representing the specified relative name in the specified package in the given location.

If the returned object represents a source or class file, it must be an instance of JavaFileObject.

Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name. For example, to locate the properties file "resources/compiler.properties" in the package "com.sun.tools.javac" in the SOURCE_PATH location, this method might be called like so:

getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

If the call was executed on Windows, with SOURCE_PATH set to "C:\Documents and Settings\UncleBob\src\share\classes", a valid result would be a file object representing the file "C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties".
Returns: a file object, might return {@code null} if the file does not exist
Parameters:
- location - a location
- packageName - a package name
- relativeName - a relative name
Throws:
- IllegalArgumentException - if the location is not known to this file manager and the file manager does not support unknown locations, or if {@code relativeName} is not valid
- IOException - if an I/O error occurred, or if {@link #close} has been called and this file manager cannot be reopened
- IllegalStateException - if {@link #close} has been called and this file manager cannot be reopened

public FileObject getFileForOutput (Location location, String packageName, String relativeName, FileObject sibling) throws IOException

Gets a file object for output representing the specified relative name in the specified package in the given location.

public JavaFileObject getJavaFileForInput (Location location, String className, Kind kind) throws IOException

Gets a file object for input representing the specified class of the specified kind in the given location.

public JavaFileObject getJavaFileForOutput (Location location, String className, Kind kind, FileObject sibling) throws IOException

Gets a file object for output representing the specified class of the specified kind in the given location.

public boolean handleOption (String current, Iterator<String> remaining)

Handles one option.

Handles one option. If current is an option to this
file manager it will consume any arguments to that option from
remaining and return true, otherwise return false.
Returns: true if this option was handled by this file manager, false otherwise
Parameters:
- current - current option
- remaining - remaining options
Throws:
- IllegalArgumentException - if this option to this file manager is used incorrectly
- IllegalStateException - if {@link #close} has been called and this file manager cannot be reopened

public boolean hasLocation (Location location)

Determines if a location is known to this file manager.

public String inferBinaryName (Location location, JavaFileObject file)

Infers a binary name of a file object based on a location.

public boolean isSameFile (FileObject a, FileObject b)

Compares two file objects and return true if they represent the same underlying object.

public Iterable<JavaFileObject> list (Location location, String packageName, Set<Kind> kinds, boolean recurse) throws IOException

Lists all file objects matching the given criteria in the given location.