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