com.sun.tools.javac.api

Class WrappingJavaFileManager<M extends JavaFileManager>

java.lang.Object

javax.tools.ForwardingJavaFileManager<M>

com.sun.tools.javac.api.WrappingJavaFileManager<M>

Type Parameters:

M - the type of file manager wrapped to by this object

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, JavaFileManager, OptionChecker

public class WrappingJavaFileManager<M extends JavaFileManager>
extends ForwardingJavaFileManager<M>

Wraps all calls to a given file manager. Subclasses of this class might override some of these methods and might also provide additional fields and methods.

This class might be moved to javax.tools in a future release.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:

1.6

Author:

Peter von der Ahé

Nested Class Summary

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

JavaFileManager.Location

Field Summary

Fields inherited from class javax.tools.ForwardingJavaFileManager

fileManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WrappingJavaFileManager(M fileManager) Creates a new instance of WrappingJavaFileManager.

Method Summary

Modifier and Type	Method and Description
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) Gets a file object for input representing the specified relative name in the specified package in the given location.
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) Gets a file object for output representing the specified relative name in the specified package in the given location.
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) Gets a file object for input representing the specified class of the specified kind in the given location.
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) Gets a file object for output representing the specified class of the specified kind in the given location.
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject file) Infers a binary name of a file object based on a location.
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) Lists all file objects matching the given criteria in the given location.
protected FileObject	unwrap(FileObject fileObject) This implementation returns the given file object.
protected JavaFileObject	unwrap(JavaFileObject fileObject) This implementation forwards to unwrap(FileObject).
protected URI	unwrap(URI uri) This implementation returns the given URI.
protected FileObject	wrap(FileObject fileObject) This implementation returns the given file object.
protected Iterable<JavaFileObject>	wrap(Iterable<JavaFileObject> fileObjects) This implementation maps the given list of file objects by calling wrap on each.
protected JavaFileObject	wrap(JavaFileObject fileObject) This implementation forwards to wrap(FileObject).

Methods inherited from class javax.tools.ForwardingJavaFileManager

close, flush, getClassLoader, handleOption, hasLocation, isSameFile, isSupportedOption

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WrappingJavaFileManager

protected WrappingJavaFileManager(M fileManager)

Creates a new instance of WrappingJavaFileManager.

Parameters:

fileManager - file manager to be wrapped

Method Detail

wrap

protected FileObject wrap(FileObject fileObject)

This implementation returns the given file object. Subclasses may override this behavior.

Parameters:

fileObject - a file object

wrap

protected JavaFileObject wrap(JavaFileObject fileObject)

This implementation forwards to wrap(FileObject). Subclasses may override this behavior.

Parameters:

fileObject - a file object

Throws:

ClassCastException - if the file object returned from the forwarded call is not a subtype of JavaFileObject

unwrap

protected FileObject unwrap(FileObject fileObject)

This implementation returns the given file object. Subclasses may override this behavior.

Parameters:

fileObject - a file object

unwrap

protected JavaFileObject unwrap(JavaFileObject fileObject)

This implementation forwards to unwrap(FileObject). Subclasses may override this behavior.

Parameters:

fileObject - a file object

Throws:

ClassCastException - if the file object returned from the forwarded call is not a subtype of JavaFileObject

wrap

protected Iterable<JavaFileObject> wrap(Iterable<JavaFileObject> fileObjects)

This implementation maps the given list of file objects by calling wrap on each. Subclasses may override this behavior.

Parameters:

fileObjects - a list of file objects

Returns:

the mapping

unwrap

protected URI unwrap(URI uri)

This implementation returns the given URI. Subclasses may override this behavior.

Parameters:

uri - a URI

list

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

Description copied from interface: JavaFileManager

Lists all file objects matching the given criteria in the given location. List file objects in "subpackages" if recurse is true.

Note: even if the given location is unknown to this file manager, it may not return null. Also, an unknown location may not cause an exception.

Specified by:

list in interface JavaFileManager

Overrides:

list in class ForwardingJavaFileManager<M extends JavaFileManager>

Parameters:

location - a location

packageName - a package name

kinds - return objects only of these kinds

recurse - if true include "subpackages"

Returns:

an Iterable of file objects matching the given criteria

Throws:

IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

inferBinaryName

public String inferBinaryName(JavaFileManager.Location location,
                              JavaFileObject file)

Description copied from interface: JavaFileManager

Infers a binary name of a file object based on a location. The binary name returned might not be a valid binary name according to The Java™ Language Specification.

Specified by:

inferBinaryName in interface JavaFileManager

Overrides:

inferBinaryName in class ForwardingJavaFileManager<M extends JavaFileManager>

Parameters:

location - a location

file - a file object

Returns:

a binary name or null the file object is not found in the given location

Throws:

IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

getJavaFileForInput

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

Description copied from interface: JavaFileManager

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

Specified by:

getJavaFileForInput in interface JavaFileManager

Overrides:

getJavaFileForInput in class ForwardingJavaFileManager<M extends JavaFileManager>

Parameters:

location - a location

className - the name of a class

kind - the kind of file, must be one of SOURCE or CLASS

Returns:

a file object, might return null if the file does not exist

Throws:

IllegalArgumentException - if the location is not known to this file manager and the file manager does not support unknown locations, or if the kind is not valid

UnsupportedOperationException

IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

getJavaFileForOutput

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

Description copied from interface: JavaFileManager

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

Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

Specified by:

getJavaFileForOutput in interface JavaFileManager

Overrides:

getJavaFileForOutput in class ForwardingJavaFileManager<M extends JavaFileManager>

Parameters:

location - a location

className - the name of a class

kind - the kind of file, must be one of SOURCE or CLASS

sibling - a file object to be used as hint for placement; might be null

Returns:

a file object for output

Throws:

IllegalArgumentException - if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if the kind is not valid

UnsupportedOperationException

IllegalStateException - JavaFileManager.close() has been called and this file manager cannot be reopened

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

getFileForInput

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

Description copied from interface: JavaFileManager

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".

Specified by:

getFileForInput in interface JavaFileManager

Overrides:

getFileForInput in class ForwardingJavaFileManager<M extends JavaFileManager>

Parameters:

location - a location

packageName - a package name

relativeName - a relative name

Returns:

a file object, might return null if the file does not exist

Throws:

IllegalArgumentException - if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid

IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

getFileForOutput

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

Description copied from interface: JavaFileManager

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

Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

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 or next to the sibling argument. See getFileForInput for an example.

Specified by:

getFileForOutput in interface JavaFileManager

Overrides:

getFileForOutput in class ForwardingJavaFileManager<M extends JavaFileManager>

Parameters:

location - a location

packageName - a package name

relativeName - a relative name

sibling - a file object to be used as hint for placement; might be null

Returns:

a file object

Throws:

IllegalArgumentException - if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid

IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened