Класс EventType

java.lang.Object

jdk.jfr.EventType

public final class EventType extends Object

Описывает событие, его поля, настройки и аннотации.

Since:: 9

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

Модификатор и тип	Метод	Описание
`<A extends Annotation> A`	`getAnnotation(Class<A> annotationClass)`	Возвращает первую аннотацию для указанного типа, если элемент аннотации с тем же именем присутствует напрямую, в противном случае `null`.
`List<AnnotationElement>`	`getAnnotationElements()`	Возвращает неизменяемый список элементов аннотаций для данного типа события.
`List<String>`	`getCategoryNames()`	Возвращает список удобочитаемых имён, составляющих категории для данного типа события (например, `"Java Application"`, `"Statistics"`).
`String`	`getDescription()`	Возвращает краткое предложение, описывающее класс события.
`static EventType`	`getEventType(Class<? extends Event> eventClass)`	Возвращает тип события для класса события или `null`, если он не существует.
`ValueDescriptor`	`getField(String name)`	Возвращает поле с указанным именем или `null`, если оно не существует.
`List<ValueDescriptor>`	`getFields()`	Возвращает неизменяемый список описателей, описывающих поля события данного типа события.
`long`	`getId()`	Возвращает уникальный идентификатор для данного типа события в виртуальной машине Java (JVM).
`String`	`getLabel()`	Возвращает удобочитаемое имя (например, `"CPU Load"`).
`String`	`getName()`	Возвращает идентификатор события (например, `"jdk.CPULoad"`).
`List<SettingDescriptor>`	`getSettingDescriptors()`	Возвращает неизменяемый список описателей настроек, описывающих доступные настройки событий для данного типа события.
`boolean`	`isEnabled()`	Возвращает `true`, если событие включено и запущена как минимум одна запись, `false`, в противном случае.

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

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

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

getFields

public List<ValueDescriptor> getFields()

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

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

getField

public ValueDescriptor getField(String name)

Возвращает поле с указанным именем, или null если оно не существует.

Можно получить доступ к вложенному полю, используя "." (например, "thread.group.parent.name).

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

getName

public String getName()

Возвращает идентификатор события (например, "jdk.CPULoad").

Идентификатор — это полное имя класса события, если оно не задано с помощью аннотации Name.

Возвращает:

имя, а не null

См. также:

Name

getLabel

public String getLabel()

Возвращает удобочитаемое имя (например, "CPU Load").

Метка класса события может быть установлена с помощью аннотации Label.

Возвращает:

метку или null если метка не установлена

См. также:

Label

getId

public long getId()

Возвращает уникальный идентификатор для данного типа события в виртуальной машине Java (JVM).

Возвращает:: Идентификатор, используемый в JVM

getAnnotationElements

public List<AnnotationElement> getAnnotationElements()

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

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

isEnabled

public boolean isEnabled()

Возвращает true если событие включено и запущена как минимум одна запись, false в противном случае.

По умолчанию событие включено. Событие можно включить или отключить, установив значение настройки enabled в true или false, программно или с помощью файла конфигурации. Событие также можно отключить, добавив к событию аннотацию @Enabled(false).

Возвращает:

true, если событие включено, false в противном случае

См. также:

getDescription

public String getDescription()

Возвращает краткое предложение, описывающее класс события.

Описание класса события может быть установлено с помощью аннотации Description.

Возвращает:

описание, или null если описание отсутствует

См. также:

Description

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationClass)

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

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

getEventType

public static EventType getEventType(Class<? extends Event> eventClass)

Возвращает тип события для класса события, или null если он не существует.

Параметры:: eventClass - класс события, не null
Возвращает:: класс события или null, если класс не существует
Исключения:: IllegalArgumentException - если eventClass является абстрактным классом; IllegalStateException - если класс помечен аннотацией Registered(false), но не зарегистрирован вручную

getSettingDescriptors

public List<SettingDescriptor> getSettingDescriptors()

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

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

getCategoryNames

public List<String> getCategoryNames()

Возвращает список удобочитаемых имён, составляющих категории для данного типа события (например, "Java Application", "Statistics").

Возвращает:

неизменяемый список имён категорий или список с именем "Uncategorized", если категории не заданы

См. также:

Category

© 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.jfr/jdk/jfr/EventType.html