Java руководство для начинающих - Шилдт Герберт (2012)

Применяя аннотацию, вы тем самым задаете значения ее членов. Ниже приведен пример аннотации MyAnno, применяемой к методу.

// Аннотирование метода.

@MyAnno(str = "Annotation Example", val = 100)

public static void myMeth() { // ...

Эта аннотация связывается с методом myMeth (). Обратите внимание на синтаксис аннотации. Имени аннотации предшествует знак @, а после имени следует список, предназначенный для инициализации ее членов. Для того чтобы задать значение члена аннотации, следует присвоить это значение имени данного члена. В рассматриваемом здесь примере символьная строка "Annotation Example" (Пример аннотации) присваивается члену str аннотации MyAnno. Обратите внимание на то, что в операторе присваивания скобки после члена str не указываются. При присваивании значения члену аннотации используется только его имя. В этом отношении члены аннотации похожи на поля.

Аннотация без параметров называется маркером. При определении маркера круглые скобки не указываются. Главное назначение маркера — пометить объявление некоторым атрибутом.

В Java определено немало встроенных аннотаций. Некоторые из них считаются аннотациями общего назначения, но большинство являются специализированными. В пакет java.lang.annotation входят аннотации ©Retention, ©Documented, @Target и @Inherited. Аннотации @Override, @Deprecated и ©SuppressWarnings включены в пакет ava.lang. Назначение этих семи аннотаций приведено в табл. 12.1.

Таблица 12.1. Встроенные аннотации

Аннотация

Описание

@Retention

Определяет правила сохранения, связываемые с аннотацией. Правила сохранения определяют, как долго аннотация будет присутствовать в процессе компиляции и развертывания прикладной программы

@Documented

Маркер, сообщающий инструментальному средству о том, что аннотация документируется. Желательно использовать только как аннотацию к аннотации объявления

@Target

Задает виды объявлений, к которым может быть применена аннотация. Желательно использовать только в качестве одной аннотации к другой. Данная аннотация принимает аргумент в виде константы перечислимого типа ElementType, в котором определены различные константы, в том числе CONSTRUCTOR, FIELD и METHOD. Аргумент определяет виды объявлений, к которым может быть применена аннотация

@Inherited

Маркер, указывающий на то, что аннотация суперкласса должна наследоваться подклассом

@Override

Метод, аннотированный как ©Override, должен переопределять метод суперкласса. Если это условие не выполняется, возникает ошибка при компиляции. Данная аннотация представляет собой маркер и позволяет убедиться в том, что метод суперкласса действительно переопределен, а неперегружен

@Deprecated

Маркер, указывающий на то, что объявление устарело и было заменено новым

@SuppressWarnings

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

Ниже приведен пример, в котором аннотацией @Deprecated помечаются класс MyClass и метод getMsg (). При попытке скомпилировать программу будет выведено сообщение о том, что в исходном коде содержатся устаревшие и не рекомендованные к применению элементы.

// Пример использования аннотации @Deprecated.

// Пометить класс как не рекомендованный к применению.

@Deprecated

class MyClass {

private String msg;

MyClass(String m) {

msg = m;

}

// Пометить метод в классе как

// не рекомендованный к применению.

@Deprecated

String getMsgO {

return msg;

}

// ...

}

class AnnoDemo {