Package 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)
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling)
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind)
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling)
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject file)
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse)
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, contains, flush, getClassLoader, getLocationForModule, getLocationForModule, getServiceLoader, handleOption, hasLocation, inferModuleName, isSameFile, isSupportedOption, listLocationsForModules

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

Specified by:

list in interface JavaFileManager

Overrides:

list in class ForwardingJavaFileManager<M extends JavaFileManager>

Throws:

IllegalStateException

IOException

inferBinaryName

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

Specified by:

inferBinaryName in interface JavaFileManager

Overrides:

inferBinaryName in class ForwardingJavaFileManager<M extends JavaFileManager>

Throws:

IllegalStateException

getJavaFileForInput

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

Specified by:

getJavaFileForInput in interface JavaFileManager

Overrides:

getJavaFileForInput in class ForwardingJavaFileManager<M extends JavaFileManager>

Throws:

IllegalArgumentException

UnsupportedOperationException

IllegalStateException

IOException

getJavaFileForOutput

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

Specified by:

getJavaFileForOutput in interface JavaFileManager

Overrides:

getJavaFileForOutput in class ForwardingJavaFileManager<M extends JavaFileManager>

Throws:

IllegalArgumentException

UnsupportedOperationException

IllegalStateException

IOException

getFileForInput

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

Specified by:

getFileForInput in interface JavaFileManager

Overrides:

getFileForInput in class ForwardingJavaFileManager<M extends JavaFileManager>

Throws:

IllegalArgumentException

IllegalStateException

IOException

getFileForOutput

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

Specified by:

getFileForOutput in interface JavaFileManager

Overrides:

getFileForOutput in class ForwardingJavaFileManager<M extends JavaFileManager>

Throws:

IllegalArgumentException

IllegalStateException

IOException