Класс AnnotationElement

java.lang.Object
- jdk.jfr.AnnotationElement

public final class AnnotationElement
extends Object

Описывает метаданные события, такие как метки, описания и единицы измерения.

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

List<AnnotationElement> typeAnnotations = new ArrayList<>();
   typeannotations.add(new AnnotationElement(Name.class, "com.example.HelloWorld");
   typeAnnotations.add(new AnnotationElement(Label.class, "Hello World"));
   typeAnnotations.add(new AnnotationElement(Description.class, "Helps programmer getting started"));

   List<AnnotationElement> fieldAnnotations = new ArrayList<>();
   fieldAnnotations.add(new AnnotationElement(Label.class, "Message"));

   List<ValueDescriptor> fields = new ArrayList<>();
   fields.add(new ValueDescriptor(String.class, "message", fieldAnnotations));

   EventFactory f = EventFactory.create(typeAnnotations, fields);
   Event event = f.newEvent();
   event.commit();

Since:: 9

Конструкторы

Конструктор	Описание
`AnnotationElement(Class<? extends Annotation> annotationType)`	Создаёт элемент аннотации для использования с динамически определёнными событиями.
`AnnotationElement(Class<? extends Annotation> annotationType, Object value)`	Создаёт элемент аннотации для использования с динамически определёнными событиями.
`AnnotationElement(Class<? extends Annotation> annotationType, Map<String,Object> values)`	Создаёт элемент аннотации для использования с динамически определёнными событиями.

Методы

Модификатор и тип	Метод	Описание
`<A> A`	`getAnnotation(Class<? extends Annotation> annotationType)`	Возвращает первую аннотацию для указанного типа, если существует `AnnotationElement` с таким же именем, иначе `null`.
`List<AnnotationElement>`	`getAnnotationElements()`	Возвращает неизменяемый список элементов аннотаций для данного `AnnotationElement`.
`long`	`getTypeId()`	Возвращает идентификатор типа для данного `AnnotationElement`.
`String`	`getTypeName()`	Возвращает полное квалифицированное имя типа аннотации, соответствующего этой `AnnotationElement` (например, `"jdk.jfr.Label"`).
`Object`	`getValue(String name)`	Возвращает значение для данного `AnnotationElement`.
`List<ValueDescriptor>`	`getValueDescriptors()`	Возвращает неизменяемый список описателей, описывающих значения аннотации для этого `AnnotationElement`.
`List<Object>`	`getValues()`	Возвращает неизменяемый список значений аннотаций в порядке, соответствующем описателям значений для этого `AnnotationElement`.
`boolean`	`hasValue(String name)`	Возвращает `true` , если значение аннотации с указанным именем существует в этом `AnnotationElement`.

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

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

Конструкторы

AnnotationElement

public AnnotationElement(Class<? extends Annotation> annotationType,
                         Map<String,Object> values)

Создаёт элемент аннотации для использования с динамически определёнными событиями.

Поддерживаемые типы значений: byte, int, short, long, double, float, boolean, char, и String. Перечисления, массивы и классы не поддерживаются.

Если у annotationType есть аннотации (прямо заданные, косвенно заданные или связанные), то эти аннотации включаются рекурсивно. Однако и annotationType и любая найденная рекурсивно аннотация должны иметь аннотацию MetadataDefinition.

Для статического определения событий см. класс Event.

Параметры:: annotationType - интерфейс, расширяющий java.lang.annotation.Annotation, а не null; values - a Map с ключами, соответствующими именам методов указанного интерфейса аннотаций
Исключения:: IllegalArgumentException - если значение/ключ null, используется неподдерживаемый тип значения или значение/ключ не соответствует сигнатурам в annotationType

AnnotationElement

public AnnotationElement(Class<? extends Annotation> annotationType,
                         Object value)

Создаёт элемент аннотации для использования с динамически определёнными событиями.

Поддерживаемые типы значений: byte, int, short, long, double, float, boolean, char, и String. Перечисления, массивы и классы не поддерживаются.

Если у annotationType есть аннотации (прямо заданные, косвенно заданные или связанные), то эти аннотации включаются рекурсивно. Однако и annotationType и любая найденная рекурсивно аннотация должны иметь аннотацию MetadataDefinition.

Для статического определения событий см. класс Event.

Параметры:: annotationType - интерфейс, расширяющий java.lang.annotation.Annotation,, а не null; value - значение, соответствующее методу value указанного annotationType
Исключения:: IllegalArgumentException - если значение/ключ null, используется неподдерживаемый тип значения или значение/ключ не соответствует сигнатурам в annotationType

AnnotationElement

public AnnotationElement(Class<? extends Annotation> annotationType)

Создаёт элемент аннотации для использования с динамически определёнными событиями.

Поддерживаемые типы значений: byte, short, int, long, double, float, boolean, char, и String. Перечисления, массивы и классы не поддерживаются.

Если у annotationType есть аннотации (прямо заданные, косвенно заданные или связанные), то эти аннотации включаются рекурсивно. Однако и annotationType и любая найденная рекурсивно аннотация должны иметь аннотацию MetadataDefinition.

Для статического определения событий см. класс Event.

Параметры:: annotationType - интерфейс, расширяющий java.lang.annotation.Annotation, а не null

Методы

getValues

public List<Object> getValues()

Возвращает неизменяемый список значений аннотаций в порядке, соответствующем описателям значений для данного AnnotationElement.

Возвращает:: список значений, а не null

getValueDescriptors

public List<ValueDescriptor> getValueDescriptors()

Возвращает неизменяемый список описателей, описывающих значения аннотации для данного AnnotationElement.

Возвращает:: список описателей значений для данного Annotation, а не null

getAnnotationElements

public List<AnnotationElement> getAnnotationElements()

Возвращает неизменяемый список элементов аннотаций для данного AnnotationElement.

Возвращает:: список метааннотаций, а не null

getTypeName

public String getTypeName()

Возвращает полное квалифицированное имя типа аннотации, соответствующего этой AnnotationElement (например, "jdk.jfr.Label").

Возвращает:: имя типа, а не null

getValue

public Object getValue(String name)

Возвращает значение для данного AnnotationElement.

Параметры:: name - имя метода в интерфейсе аннотации, а не null.
Возвращает:: значение аннотации, а не null.
Исключения:: IllegalArgumentException - если метод с указанным именем не существует в аннотации

hasValue

public boolean hasValue(String name)

Возвращает true , если значение аннотации с указанным именем существует в этом AnnotationElement.

Параметры:: name - имя метода в интерфейсе аннотации для поиска, а не null
Возвращает:: true если метод существует, false в противном случае

getAnnotation

public final <A> A getAnnotation(Class<? extends Annotation> annotationType)

Возвращает первую аннотацию для указанного типа, если существует AnnotationElement с таким же именем, иначе null.

Тип параметров:: A - тип аннотации для запроса и возврата, если она существует
Параметры:: annotationType - Class object , соответствующий типу аннотации, а не null
Возвращает:: аннотацию элемента для указанного типа аннотации, если она существует, иначе null

getTypeId

public long getTypeId()

Возвращает идентификатор типа для данного AnnotationElement.

Идентификатор — уникальный идентификатор типа в виртуальной машине Java (JVM). Идентификатор может отличаться между экземплярами JVM.

Возвращает:: идентификатор типа, не отрицательный