src/share/classes/com/sun/source/util/JavacTask.java

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.source.util;
aoqi@0 27
aoqi@0 28 import java.io.IOException;
aoqi@0 29
aoqi@0 30 import javax.annotation.processing.ProcessingEnvironment;
aoqi@0 31 import javax.lang.model.element.Element;
aoqi@0 32 import javax.lang.model.type.TypeMirror;
aoqi@0 33 import javax.lang.model.util.Elements;
aoqi@0 34 import javax.lang.model.util.Types;
aoqi@0 35 import javax.tools.JavaCompiler.CompilationTask;
aoqi@0 36 import javax.tools.JavaFileObject;
aoqi@0 37
aoqi@0 38 import com.sun.source.tree.CompilationUnitTree;
aoqi@0 39 import com.sun.source.tree.Tree;
aoqi@0 40 import com.sun.tools.javac.api.BasicJavacTask;
aoqi@0 41 import com.sun.tools.javac.processing.JavacProcessingEnvironment;
aoqi@0 42 import com.sun.tools.javac.util.Context;
aoqi@0 43
aoqi@0 44 /**
aoqi@0 45 * Provides access to functionality specific to the JDK Java Compiler, javac.
aoqi@0 46 *
aoqi@0 47 * @author Peter von der Ahé
aoqi@0 48 * @author Jonathan Gibbons
aoqi@0 49 * @since 1.6
aoqi@0 50 */
aoqi@0 51 @jdk.Exported
aoqi@0 52 public abstract class JavacTask implements CompilationTask {
aoqi@0 53
aoqi@0 54 /**
aoqi@0 55 * Get the {@code JavacTask} for a {@code ProcessingEnvironment}.
aoqi@0 56 * If the compiler is being invoked using a
aoqi@0 57 * {@link javax.tools.JavaCompiler.CompilationTask CompilationTask},
aoqi@0 58 * then that task will be returned.
aoqi@0 59 * @param processingEnvironment the processing environment
aoqi@0 60 * @return the {@code JavacTask} for a {@code ProcessingEnvironment}
aoqi@0 61 * @since 1.8
aoqi@0 62 */
aoqi@0 63 public static JavacTask instance(ProcessingEnvironment processingEnvironment) {
aoqi@0 64 if (!processingEnvironment.getClass().getName().equals(
aoqi@0 65 "com.sun.tools.javac.processing.JavacProcessingEnvironment"))
aoqi@0 66 throw new IllegalArgumentException();
aoqi@0 67 Context c = ((JavacProcessingEnvironment) processingEnvironment).getContext();
aoqi@0 68 JavacTask t = c.get(JavacTask.class);
aoqi@0 69 return (t != null) ? t : new BasicJavacTask(c, true);
aoqi@0 70 }
aoqi@0 71
aoqi@0 72 /**
aoqi@0 73 * Parse the specified files returning a list of abstract syntax trees.
aoqi@0 74 *
aoqi@0 75 * @return a list of abstract syntax trees
aoqi@0 76 * @throws IOException if an unhandled I/O error occurred in the compiler.
aoqi@0 77 * @throws IllegalStateException if the operation cannot be performed at this time.
aoqi@0 78 */
aoqi@0 79 public abstract Iterable<? extends CompilationUnitTree> parse()
aoqi@0 80 throws IOException;
aoqi@0 81
aoqi@0 82 /**
aoqi@0 83 * Complete all analysis.
aoqi@0 84 *
aoqi@0 85 * @return a list of elements that were analyzed
aoqi@0 86 * @throws IOException if an unhandled I/O error occurred in the compiler.
aoqi@0 87 * @throws IllegalStateException if the operation cannot be performed at this time.
aoqi@0 88 */
aoqi@0 89 public abstract Iterable<? extends Element> analyze() throws IOException;
aoqi@0 90
aoqi@0 91 /**
aoqi@0 92 * Generate code.
aoqi@0 93 *
aoqi@0 94 * @return a list of files that were generated
aoqi@0 95 * @throws IOException if an unhandled I/O error occurred in the compiler.
aoqi@0 96 * @throws IllegalStateException if the operation cannot be performed at this time.
aoqi@0 97 */
aoqi@0 98 public abstract Iterable<? extends JavaFileObject> generate() throws IOException;
aoqi@0 99
aoqi@0 100 /**
aoqi@0 101 * The specified listener will receive notification of events
aoqi@0 102 * describing the progress of this compilation task.
aoqi@0 103 *
aoqi@0 104 * If another listener is receiving notifications as a result of a prior
aoqi@0 105 * call of this method, then that listener will no longer receive notifications.
aoqi@0 106 *
aoqi@0 107 * Informally, this method is equivalent to calling {@code removeTaskListener} for
aoqi@0 108 * any listener that has been previously set, followed by {@code addTaskListener}
aoqi@0 109 * for the new listener.
aoqi@0 110 *
aoqi@0 111 * @throws IllegalStateException if the specified listener has already been added.
aoqi@0 112 */
aoqi@0 113 public abstract void setTaskListener(TaskListener taskListener);
aoqi@0 114
aoqi@0 115 /**
aoqi@0 116 * The specified listener will receive notification of events
aoqi@0 117 * describing the progress of this compilation task.
aoqi@0 118 *
aoqi@0 119 * This method may be called at any time before or during the compilation.
aoqi@0 120 *
aoqi@0 121 * @throws IllegalStateException if the specified listener has already been added.
aoqi@0 122 * @since 1.8
aoqi@0 123 */
aoqi@0 124 public abstract void addTaskListener(TaskListener taskListener);
aoqi@0 125
aoqi@0 126 /**
aoqi@0 127 * The specified listener will no longer receive notification of events
aoqi@0 128 * describing the progress of this compilation task.
aoqi@0 129 *
aoqi@0 130 * This method may be called at any time before or during the compilation.
aoqi@0 131 *
aoqi@0 132 * @since 1.8
aoqi@0 133 */
aoqi@0 134 public abstract void removeTaskListener(TaskListener taskListener);
aoqi@0 135
aoqi@0 136 /**
aoqi@0 137 * Get a type mirror of the tree node determined by the specified path.
aoqi@0 138 * This method has been superceded by methods on
aoqi@0 139 * {@link com.sun.source.util.Trees Trees}.
aoqi@0 140 * @see com.sun.source.util.Trees#getTypeMirror
aoqi@0 141 */
aoqi@0 142 public abstract TypeMirror getTypeMirror(Iterable<? extends Tree> path);
aoqi@0 143
aoqi@0 144 /**
aoqi@0 145 * Get a utility object for dealing with program elements.
aoqi@0 146 */
aoqi@0 147 public abstract Elements getElements();
aoqi@0 148
aoqi@0 149 /**
aoqi@0 150 * Get a utility object for dealing with type mirrors.
aoqi@0 151 */
aoqi@0 152 public abstract Types getTypes();
aoqi@0 153 }

mercurial