Класс JavacTask

java.lang.Object

com.sun.source.util.JavacTask

Все реализуемые интерфейсы:: Callable<Boolean>, JavaCompiler.CompilationTask

public abstract class JavacTask extends Object implements JavaCompiler.CompilationTask

Обеспечивает доступ к функциональности, специфичной для компилятора JDK Java, javac.

С момента:: 1.6

Краткое описание конструкторов

Конструктор	Описание
`JavacTask()`	Конструктор для вызова подклассами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`abstract void`	`addTaskListener(TaskListener taskListener)`	Добавляет указанный слушатель, чтобы он получал уведомления о событиях, описывающих ход выполнения этой задачи компиляции.
`abstract Iterable<? extends Element>`	`analyze()`	Завершает весь анализ.
`abstract Iterable<? extends JavaFileObject>`	`generate()`	Генерирует код.
`abstract Elements`	`getElements()`	Возвращает служебный объект для работы с элементами программы.
`abstract TypeMirror`	`getTypeMirror(Iterable<? extends Tree> path)`	Возвращает зеркало типа узла дерева, определяемого заданным путем.
`abstract Types`	`getTypes()`	Возвращает служебный объект для работы со зеркалами типов.
`static JavacTask`	`instance(ProcessingEnvironment processingEnvironment)`	Возвращает `JavacTask` для `ProcessingEnvironment`.
`abstract Iterable<? extends CompilationUnitTree>`	`parse()`	Парсит указанные файлы, возвращая список абстрактных синтаксических деревьев.
`abstract void`	`removeTaskListener(TaskListener taskListener)`	Удаляет указанного слушателя, чтобы он больше не получал уведомлений о событиях, описывающих ход выполнения этой задачи компиляции.
`void`	`setParameterNameProvider(ParameterNameProvider provider)`	Устанавливает указанный `ParameterNameProvider`.
`abstract void`	`setTaskListener(TaskListener taskListener)`	Устанавливает указанного слушателя для получения уведомлений о событиях, описывающих ход выполнения этой задачи компиляции.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Методы, объявленные в интерфейсе javax.tools.JavaCompiler.CompilationTask

addModules, call, setLocale, setProcessors

Подробное описание конструкторов

JavacTask

public 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 - путь

Возвращает:

зеркало типа

См. также:

Trees.getTypeMirror(com.sun.source.util.TreePath)

getElements

public abstract Elements getElements()

Возвращает служебный объект для работы с элементами программы.

Возвращает:: служебный объект для работы с элементами программы

getTypes

public abstract Types getTypes()

Возвращает служебный объект для работы со зеркалами типов.

Возвращает:: служебный объект для работы со зеркалами типов

© 1993, 2021, 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/17/docs/api/jdk.compiler/com/sun/source/util/JavacTask.html