Класс 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();
}
- Since:
- 9
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
<A extends Annotation> |
getAnnotation |
Возвращает первую аннотацию указанного типа, если элемент аннотации с таким же именем присутствует непосредственно, иначе null. |
List |
getAnnotationElements() |
Возвращает неизменяемый список элементов аннотаций для этого типа события. |
List |
getCategoryNames() |
Возвращает список удобочитаемых имен, составляющих категории для этого типа события (например, "Java Application", "Statistics"). |
String |
getDescription() |
Возвращает краткое предложение, описывающее класс события. |
static EventType |
getEventType |
Возвращает тип события для класса события, или null, если он не существует. |
ValueDescriptor |
getField |
Возвращает поле с указанным именем, или null, если оно не существует. |
List |
getFields() |
Возвращает неизменяемый список описателей, описывающих поля события этого типа события. |
long |
getId() |
Возвращает уникальный идентификатор этого типа события в виртуальной машине Java (JVM). |
String |
getLabel() |
Возвращает удобочитаемое имя (например, "CPU Load"). |
String |
getName() |
Возвращает идентификатор события (например, "jdk.CPULoad"). |
List |
getSettingDescriptors() |
Возвращает неизменяемый список описателей настроек, описывающих доступные настройки события для этого типа события. |
boolean |
isEnabled() |
Возвращает true, если событие включено и выполняется по крайней мере одна запись, false в противном случае. |
Подробное описание методов
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()
- Возвращает:
- идентификатор, используемый в JVM
getAnnotationElements
public List<AnnotationElement> getAnnotationElements()
- Возвращает:
- неизменяемый список аннотаций или пустой список, если аннотаций нет, не
null
isEnabled
public boolean isEnabled()
true, если событие включено и выполняется по крайней мере одна запись, false в противном случае. По умолчанию событие включено. Событие можно включить или выключить, установив настройку включения в 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, 2023, 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/21/docs/api/jdk.jfr/jdk/jfr/EventType.html