duke@1: /*
ohair@554:  * Copyright (c) 2005, 2006, 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.source.util;
duke@1: 
duke@1: import com.sun.source.tree.CompilationUnitTree;
duke@1: import com.sun.source.tree.Tree;
duke@1: import java.io.IOException;
duke@1: import javax.lang.model.element.Element;
duke@1: import javax.lang.model.type.TypeMirror;
duke@1: import javax.lang.model.util.Elements;
duke@1: import javax.lang.model.util.Types;
duke@1: import javax.tools.JavaCompiler.CompilationTask;
duke@1: import javax.tools.JavaFileObject;
duke@1: 
duke@1: /**
jjg@582:  * Provides access to functionality specific to the JDK Java Compiler, javac.
duke@1:  *
duke@1:  * @author Peter von der Ahé
duke@1:  * @author Jonathan Gibbons
duke@1:  * @since 1.6
duke@1:  */
duke@1: public abstract class JavacTask implements CompilationTask {
duke@1: 
duke@1:     /**
duke@1:      * Parse the specified files returning a list of abstract syntax trees.
duke@1:      *
duke@1:      * @return a list of abstract syntax trees
duke@1:      * @throws IOException if an unhandled I/O error occurred in the compiler.
duke@1:      */
duke@1:     public abstract Iterable<? extends CompilationUnitTree> parse()
duke@1:         throws IOException;
duke@1: 
duke@1:     /**
duke@1:      * Complete all analysis.
duke@1:      *
duke@1:      * @return a list of elements that were analyzed
duke@1:      * @throws IOException if an unhandled I/O error occurred in the compiler.
duke@1:      */
duke@1:     public abstract Iterable<? extends Element> analyze() throws IOException;
duke@1: 
duke@1:     /**
duke@1:      * Generate code.
duke@1:      *
duke@1:      * @return a list of files that were generated
duke@1:      * @throws IOException if an unhandled I/O error occurred in the compiler.
duke@1:      */
duke@1:     public abstract Iterable<? extends JavaFileObject> generate() throws IOException;
duke@1: 
duke@1:     /**
duke@1:      * The specified listener will receive events describing the progress of
duke@1:      * this compilation task.
duke@1:      */
duke@1:     public abstract void setTaskListener(TaskListener taskListener);
duke@1: 
duke@1:     /**
duke@1:      * Get a type mirror of the tree node determined by the specified path.
duke@1:      */
duke@1:     public abstract TypeMirror getTypeMirror(Iterable<? extends Tree> path);
duke@1:     /**
duke@1:      * Get a utility object for dealing with program elements.
duke@1:      */
duke@1:     public abstract Elements getElements();
duke@1: 
duke@1:     /**
duke@1:      * Get a utility object for dealing with type mirrors.
duke@1:      */
duke@1:     public abstract Types getTypes();
duke@1: }