Краткий обзор (Зеркальный API)

Пакеты
Пакет	Описание
com.sun.mirror.apt	Классы, используемые, чтобы передать информацию между процессорами аннотации и инструментом обработки аннотации.
com.sun.mirror.declaration	Интерфейсы, используемые, чтобы смоделировать объявления элемента программы.
com.sun.mirror.type	Интерфейсы, привыкшие к модельным типам.
com.sun.mirror.util	Утилиты, чтобы помочь в обработке объявлений и типов.

Зеркальный API используется, чтобы смоделировать семантическую структуру программы. Это обеспечивает представления объектов, объявленных в программе, таких как классы, методы, и поля. Конструкции ниже уровня метода, такие как отдельные операторы и выражения, не представляются.

Также включенный поддержка записи процессоров аннотации, чтобы исследовать и обработать аннотации элементов программы. Процессор аннотации, как пример, может создать новые исходные файлы и XML-документы, которые будут использоваться в соединении с исходным кодом.

Характеристики API

Программа представляется на уровне языка, а не на уровне виртуальной машины. Вложенные классы, например, обрабатываются как первоклассные конструкции, а не в преобразованной форме, понятой под VM. И исходный код и скомпилированный код (файлы класса) могут быть смоделированы таким образом.

Программы моделируются в их статической, или разовой сборкой, форме. Это отличается от API Reflection, который предоставляет информацию о времени выполнения о классах и объектах.

API не оказывает прямую поддержку для того, чтобы генерировать новый код.

Объявления и Типы

Зеркальный API представляет конструкции программы преимущественно через Declaration взаимодействуйте через интерфейс и его иерархия подынтерфейсов в пакете com.sun.mirror.declaration. Declaration представляет элемент программы, такой как пакет, класс, или метод. Интерфейсная иерархия изображается здесь.

Типы представляются TypeMirror взаимодействуйте через интерфейс и его иерархия подынтерфейсов в пакете com.sun.mirror.type. Типы включают типы примитивов, класс и интерфейсные типы, выстраивают типы, вводят переменные, и подстановочные знаки. Интерфейсная иерархия изображается здесь.

API делает четкое различие между объявлениями и типами. Это старше значащее для универсальных типов, где единственное объявление может определить бесконечное семейство типов. Например, объявление java.util.Set определяет необработанный тип java.util.Set, параметризованный тип java.util.Set<String>, и намного больше. Только объявление может быть аннотировано, например, и только тип может появиться в сигнатуре метода.

Смоделированная программа может быть неполной, в котором она может зависеть от неизвестного класса или соединить интерфейсом с типом. Это может быть результатом ошибки обработки, такой как недостающий файл класса, или возможно недостающий тип должен быть создан процессором аннотации. См. DeclaredType для информации о том, как обрабатываются такие неизвестные типы.

Утилиты и Поддержка Инструмента

com.sun.mirror.util пакет обеспечивает утилиты, чтобы помочь в обработке объявлений и типов. Включенный поддержка использования шаблона разработки посетителя, работая на объектах типа и объявлении.

com.sun.mirror.apt пакет поддерживает запись процессоров аннотации. Это предоставляет механизм им, чтобы взаимодействовать с инструментом обработки аннотации.