Класс EventType

java.lang.Object
- jdk.jfr.EventType

public final class EventType
extends Object

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

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

Возвращает:: описатель значения, описывающий поле, или 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 — в противном случае
См. также:: Enabled, Recording.enable(Class)

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