| 1 | /* |
| 2 | * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package com.sun.source.util; |
| 27 | |
| 28 | import com.sun.source.tree.CompilationUnitTree; |
| 29 | import com.sun.source.tree.Tree; |
| 30 | import java.io.IOException; |
| 31 | import javax.lang.model.element.Element; |
| 32 | import javax.lang.model.type.TypeMirror; |
| 33 | import javax.lang.model.util.Elements; |
| 34 | import javax.lang.model.util.Types; |
| 35 | import javax.tools.JavaCompiler.CompilationTask; |
| 36 | import javax.tools.JavaFileObject; |
| 37 | |
| 38 | /** |
| 39 | * Provides access to functionality specific to the Sun Java Compiler, javac. |
| 40 | * |
| 41 | * @author Peter von der Ahé |
| 42 | * @author Jonathan Gibbons |
| 43 | * @since 1.6 |
| 44 | */ |
| 45 | public abstract class JavacTask implements CompilationTask { |
| 46 | |
| 47 | /** |
| 48 | * Parse the specified files returning a list of abstract syntax trees. |
| 49 | * |
| 50 | * @return a list of abstract syntax trees |
| 51 | * @throws IOException if an unhandled I/O error occurred in the compiler. |
| 52 | */ |
| 53 | public abstract Iterable<? extends CompilationUnitTree> parse() |
| 54 | throws IOException; |
| 55 | |
| 56 | /** |
| 57 | * Complete all analysis. |
| 58 | * |
| 59 | * @return a list of elements that were analyzed |
| 60 | * @throws IOException if an unhandled I/O error occurred in the compiler. |
| 61 | */ |
| 62 | public abstract Iterable<? extends Element> analyze() throws IOException; |
| 63 | |
| 64 | /** |
| 65 | * Generate code. |
| 66 | * |
| 67 | * @return a list of files that were generated |
| 68 | * @throws IOException if an unhandled I/O error occurred in the compiler. |
| 69 | */ |
| 70 | public abstract Iterable<? extends JavaFileObject> generate() throws IOException; |
| 71 | |
| 72 | /** |
| 73 | * The specified listener will receive events describing the progress of |
| 74 | * this compilation task. |
| 75 | */ |
| 76 | public abstract void setTaskListener(TaskListener taskListener); |
| 77 | |
| 78 | /** |
| 79 | * Get a type mirror of the tree node determined by the specified path. |
| 80 | */ |
| 81 | public abstract TypeMirror getTypeMirror(Iterable<? extends Tree> path); |
| 82 | /** |
| 83 | * Get a utility object for dealing with program elements. |
| 84 | */ |
| 85 | public abstract Elements getElements(); |
| 86 | |
| 87 | /** |
| 88 | * Get a utility object for dealing with type mirrors. |
| 89 | */ |
| 90 | public abstract Types getTypes(); |
| 91 | } |