Класс JavacTask
java.lang.Object
com.sun.source.util.JavacTask
- Все реализуемые интерфейсы:
Callable<Boolean>, JavaCompiler.CompilationTask
public abstract class JavacTask extends Object implements JavaCompiler.CompilationTask
Предоставляет доступ к функциям, специфичным для компилятора Java из JDK — javac.
- Начиная с:
- 1.6
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Конструктор для вызова подклассами. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
abstract void |
addTaskListener |
Добавляет указанный прослушиватель, чтобы он получал уведомления о событиях, описывающих ход выполнения этой задачи компиляции. |
abstract Iterable |
analyze() |
Завершает весь анализ. |
abstract Iterable |
generate() |
Генерирует код. |
abstract Elements |
getElements() |
Возвращает служебный объект для работы с элементами программы. |
abstract TypeMirror |
getTypeMirror |
Возвращает зеркало типа узла дерева, определяемого указанным путем. |
abstract Types |
getTypes() |
Возвращает служебный объект для работы с зеркалами типов. |
static JavacTask |
instance |
Возвращает JavacTask для ProcessingEnvironment. |
abstract Iterable |
parse() |
Разбирает указанные файлы и возвращает список абстрактных синтаксических деревьев. |
abstract void |
removeTaskListener |
Удаляет указанный прослушиватель, чтобы он больше не получал уведомления о событиях, описывающих ход выполнения этой задачи компиляции. |
void |
setParameterNameProvider |
Задает указанный ParameterNameProvider. |
abstract void |
setTaskListener |
Задает указанный прослушиватель для получения уведомлений о событиях, описывающих ход выполнения этой задачи компиляции. |
Методы, объявленные в классе Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Методы, объявленные в интерфейсе JavaCompiler.CompilationTask
addModules, call, setLocale, setProcessors
Подробное описание конструкторов
JavacTask
protected JavacTask()
Конструктор для вызова подклассами.
Подробное описание методов
instance
public static JavacTask instance(ProcessingEnvironment processingEnvironment)
Возвращает
JavacTask для ProcessingEnvironment. Если компилятор вызывается с помощью CompilationTask, возвращается эта задача.- Параметры:
-
processingEnvironment— среда обработки - Возвращает:
JavacTaskдляProcessingEnvironment- Начиная с:
- 1.8
parse
public abstract Iterable<? extends CompilationUnitTree> parse() throws IOException
Разбирает указанные файлы и возвращает список абстрактных синтаксических деревьев.
- Возвращает:
- список абстрактных синтаксических деревьев
- Вызывает исключения:
-
IOException— если в компиляторе произошла необработанная ошибка ввода-вывода. -
IllegalStateException— если в данный момент операцию выполнить невозможно.
analyze
public abstract Iterable<? extends Element> analyze() throws IOException
Завершает весь анализ.
- Возвращает:
- список проанализированных элементов
- Вызывает исключения:
-
IOException— если в компиляторе произошла необработанная ошибка ввода-вывода. -
IllegalStateException— если в данный момент операцию выполнить невозможно.
generate
public abstract Iterable<? extends JavaFileObject> generate() throws IOException
Генерирует код.
- Возвращает:
- список сгенерированных файлов
- Вызывает исключения:
-
IOException— если в компиляторе произошла необработанная ошибка ввода-вывода. -
IllegalStateException— если в данный момент операцию выполнить невозможно.
setTaskListener
public abstract void setTaskListener(TaskListener taskListener)
Задает прослушиватель для получения уведомлений о событиях, описывающих ход выполнения этой задачи компиляции. Если в результате предыдущего вызова этого метода уведомления получает другой прослушиватель, он больше не будет получать уведомления. Упрощенно, этот метод эквивалентен вызову
removeTaskListener для каждого ранее заданного прослушивателя с последующим вызовом addTaskListener для нового прослушивателя.- Параметры:
-
taskListener— прослушиватель задачи - Вызывает исключения:
-
IllegalStateException— если указанный прослушиватель уже был добавлен.
addTaskListener
public abstract void addTaskListener(TaskListener taskListener)
Добавляет указанный прослушиватель, чтобы он получал уведомления о событиях, описывающих ход выполнения этой задачи компиляции. Этот метод можно вызвать в любое время до начала компиляции или во время нее.
- Параметры:
-
taskListener— прослушиватель задачи - Вызывает исключения:
-
IllegalStateException— если указанный прослушиватель уже был добавлен. - Начиная с:
- 1.8
removeTaskListener
public abstract void removeTaskListener(TaskListener taskListener)
Удаляет указанный прослушиватель, чтобы он больше не получал уведомления о событиях, описывающих ход выполнения этой задачи компиляции. Этот метод можно вызвать в любое время до начала компиляции или во время нее.
- Параметры:
-
taskListener— прослушиватель задачи - Начиная с:
- 1.8
setParameterNameProvider
public void setParameterNameProvider(ParameterNameProvider provider)
Задает указанный
ParameterNameProvider. Его можно использовать при вызове VariableElement.getSimpleName() для параметра метода, для которого не найдено авторитетное имя. Указанный ParameterNameProvider может определить удобочитаемое имя параметра метода. Задание нового ParameterNameProvider отменит все ранее заданные ParameterNameProvider, которые больше не будут запрашиваться. Если ParameterNameProvider не задан или возвращает null из ParameterNameProvider.getParameterName(javax.lang.model.element.VariableElement), из VariableElement.getSimpleName() возвращается автоматически сформированное имя.- Требования к реализации:
- Реализация этого метода по умолчанию ничего не делает.
- Параметры:
-
provider— поставщик - Начиная с:
- 13
getTypeMirror
public abstract TypeMirror getTypeMirror(Iterable<? extends Tree> path)
Возвращает зеркало типа узла дерева, определяемого указанным путем. Этот метод заменен методами класса
Trees.- Параметры:
-
path— путь - Возвращает:
- зеркало типа
- См. также:
getElements
public abstract Elements getElements()
Возвращает служебный объект для работы с элементами программы.
- Возвращает:
- служебный объект для работы с элементами программы
getTypes
public abstract Types getTypes()
Возвращает служебный объект для работы с зеркалами типов.
- Возвращает:
- служебный объект для работы с зеркалами типов
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.compiler/com/sun/source/util/JavacTask.html