Класс EventType

java.lang.Object

jdk.jfr.EventType

public final class EventType extends Object

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

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

for (EventType eventType : FlightRecorder.getFlightRecorder().getEventTypes()) {
    System.out.println("Event Type: " + eventType.getName());
    if (eventType.getLabel() != null) {
        System.out.println("Label: " + eventType.getLabel());
    }
    if (eventType.getDescription() != null) {
        System.out.println("Description: " + eventType.getDescription());
    }
    StringJoiner s = new StringJoiner(" / ");
    for (String category : eventType.getCategoryNames()) {
        s.add(category);
    }
    System.out.println("Category: " + s);
    System.out.println("Fields: " + eventType.getFields().size());
    System.out.println("Annotations: " + eventType.getAnnotationElements().size());
    System.out.println("Settings: " + eventType.getSettingDescriptors().size());
    System.out.println("Enabled: " + eventType.isEnabled());
    System.out.println();
}

С момента:: 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

См. также:

getLabel

public String getLabel()

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

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

Возвращает:

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

См. также:

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, если описание не существует

См. также:

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", если категория не задана

См. также:

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/jdk.jfr/jdk/jfr/EventType.html