duke@1: /*
jjg@1357:  * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javac.api;
duke@1: 
duke@1: import java.io.IOException;
duke@1: import java.net.URI;
duke@1: import java.util.ArrayList;
duke@1: import java.util.Collections;
duke@1: import java.util.List;
duke@1: import java.util.Set;
jjg@1357: 
jjg@1357: import javax.tools.*;
duke@1: import javax.tools.JavaFileObject.Kind;
duke@1: 
duke@1: /**
duke@1:  * Wraps all calls to a given file manager.  Subclasses of this class
duke@1:  * might override some of these methods and might also provide
duke@1:  * additional fields and methods.
duke@1:  *
duke@1:  * <p>This class might be moved to {@link javax.tools} in a future
duke@1:  * release.
duke@1:  *
jjg@581:  * <p><b>This is NOT part of any supported API.
duke@1:  * If you write code that depends on this, you do so at your own
duke@1:  * risk.  This code and its internal interfaces are subject to change
duke@1:  * or deletion without notice.</b></p>
duke@1:  *
duke@1:  * @param <M> the type of file manager wrapped to by this object
duke@1:  *
duke@1:  * @author Peter von der Ah&eacute;
duke@1:  * @since 1.6
duke@1:  */
duke@1: public class WrappingJavaFileManager<M extends JavaFileManager> extends ForwardingJavaFileManager<M> {
duke@1: 
duke@1:     /**
duke@1:      * Creates a new instance of WrappingJavaFileManager.
duke@1:      * @param fileManager file manager to be wrapped
duke@1:      */
duke@1:     protected WrappingJavaFileManager(M fileManager) {
duke@1:         super(fileManager);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * This implementation returns the given file object.  Subclasses
duke@1:      * may override this behavior.
duke@1:      *
duke@1:      * @param fileObject a file object
duke@1:      */
duke@1:     protected FileObject wrap(FileObject fileObject) {
duke@1:         return fileObject;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * This implementation forwards to {@link #wrap(FileObject)}.
duke@1:      * Subclasses may override this behavior.
duke@1:      *
duke@1:      * @param fileObject a file object
duke@1:      * @throws ClassCastException if the file object returned from the
duke@1:      * forwarded call is not a subtype of {@linkplain JavaFileObject}
duke@1:      */
duke@1:     protected JavaFileObject wrap(JavaFileObject fileObject) {
duke@1:         return (JavaFileObject)wrap((FileObject)fileObject);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * This implementation returns the given file object.  Subclasses
duke@1:      * may override this behavior.
duke@1:      *
duke@1:      * @param fileObject a file object
duke@1:      */
duke@1:     protected FileObject unwrap(FileObject fileObject) {
duke@1:         return fileObject;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * This implementation forwards to {@link #unwrap(FileObject)}.
duke@1:      * Subclasses may override this behavior.
duke@1:      *
duke@1:      * @param fileObject a file object
duke@1:      * @throws ClassCastException if the file object returned from the
duke@1:      * forwarded call is not a subtype of {@linkplain JavaFileObject}
duke@1:      */
duke@1:     protected JavaFileObject unwrap(JavaFileObject fileObject) {
duke@1:         return (JavaFileObject)unwrap((FileObject)fileObject);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * This implementation maps the given list of file objects by
duke@1:      * calling wrap on each.  Subclasses may override this behavior.
duke@1:      *
duke@1:      * @param fileObjects a list of file objects
duke@1:      * @return the mapping
duke@1:      */
duke@1:     protected Iterable<JavaFileObject> wrap(Iterable<JavaFileObject> fileObjects) {
duke@1:         List<JavaFileObject> mapped = new ArrayList<JavaFileObject>();
duke@1:         for (JavaFileObject fileObject : fileObjects)
duke@1:             mapped.add(wrap(fileObject));
duke@1:         return Collections.unmodifiableList(mapped);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * This implementation returns the given URI.  Subclasses may
duke@1:      * override this behavior.
duke@1:      *
duke@1:      * @param uri a URI
duke@1:      */
duke@1:     protected URI unwrap(URI uri) {
duke@1:         return uri;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * @throws IllegalStateException {@inheritDoc}
duke@1:      */
duke@1:     public Iterable<JavaFileObject> list(Location location,
duke@1:                                          String packageName,
duke@1:                                          Set<Kind> kinds,
duke@1:                                          boolean recurse)
duke@1:         throws IOException
duke@1:     {
duke@1:         return wrap(super.list(location, packageName, kinds, recurse));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * @throws IllegalStateException {@inheritDoc}
duke@1:      */
duke@1:     public String inferBinaryName(Location location, JavaFileObject file) {
duke@1:         return super.inferBinaryName(location, unwrap(file));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * @throws IllegalArgumentException {@inheritDoc}
duke@1:      * @throws UnsupportedOperationException {@inheritDoc}
duke@1:      * @throws IllegalStateException {@inheritDoc}
duke@1:      */
duke@1:     public JavaFileObject getJavaFileForInput(Location location,
duke@1:                                               String className,
duke@1:                                               Kind kind)
duke@1:         throws IOException
duke@1:     {
duke@1:         return wrap(super.getJavaFileForInput(location, className, kind));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * @throws IllegalArgumentException {@inheritDoc}
duke@1:      * @throws UnsupportedOperationException {@inheritDoc}
duke@1:      * @throws IllegalStateException {@inheritDoc}
duke@1:      */
duke@1:     public JavaFileObject getJavaFileForOutput(Location location,
duke@1:                                                String className,
duke@1:                                                Kind kind,
duke@1:                                                FileObject sibling)
duke@1:         throws IOException
duke@1:     {
duke@1:         return wrap(super.getJavaFileForOutput(location, className, kind, unwrap(sibling)));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * @throws IllegalArgumentException {@inheritDoc}
duke@1:      * @throws IllegalStateException {@inheritDoc}
duke@1:      */
duke@1:     public FileObject getFileForInput(Location location,
duke@1:                                       String packageName,
duke@1:                                       String relativeName)
duke@1:         throws IOException
duke@1:     {
duke@1:         return wrap(super.getFileForInput(location, packageName, relativeName));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * @throws IllegalArgumentException {@inheritDoc}
duke@1:      * @throws IllegalStateException {@inheritDoc}
duke@1:      */
duke@1:     public FileObject getFileForOutput(Location location,
duke@1:                                        String packageName,
duke@1:                                        String relativeName,
duke@1:                                        FileObject sibling)
duke@1:         throws IOException
duke@1:     {
duke@1:         return wrap(super.getFileForOutput(location,
duke@1:                                            packageName,
duke@1:                                            relativeName,
duke@1:                                            unwrap(sibling)));
duke@1:     }
duke@1: 
duke@1: }