java.lang.Object
jdk.jfr.EventType
描述一个事件、它的字段、设置和注解。
- 自从:
- 9
-
方法总结
修饰符和类型方法描述<A extends Annotation>
AgetAnnotation(Class<A> annotationClass) 如果直接存在具有相同名称的注解元素,则返回指定类型的第一个注释,否则返回null。返回此事件类型的不可变注解元素列表。返回构成此事件类型类别的人类可读名称列表(例如,"Java Application"、"Statistics")。返回描述事件类的短句。static EventTypegetEventType(Class<? extends Event> eventClass) 返回事件类的事件类型,如果不存在则返回null。返回具有指定名称的字段,如果不存在则返回null。返回描述此事件类型的事件字段的不可变描述符列表。longgetId()返回 Java 虚拟机 (JVM) 中此事件类型的唯一 ID。getLabel()返回一个人类可读的名称(例如"CPU Load")。getName()返回事件的标识符(例如"jdk.CPULoad")。返回描述此事件类型的可用事件设置的设置描述符的不可变列表。boolean如果事件已启用且至少有一个记录正在运行,则返回true,否则返回false。
-
方法详情
-
getFields
返回描述此事件类型的事件字段的不可变描述符列表。- 返回:
-
字段描述符列表,而不是
null
-
getField
返回具有指定名称的字段,如果不存在则返回null。可以使用
"."(例如"thread.group.parent.name")对嵌套字段进行索引。- 参数:
name- 要获取的字段,而不是null- 返回:
-
描述该字段的值描述符,如果具有指定名称的字段不存在,则为
null
-
getName
返回事件的标识符(例如"jdk.CPULoad")。如果未使用
Name注释设置,则标识符是事件类的完全限定名称。- 返回:
-
名字,不是
null - 参见:
-
getLabel
返回一个人类可读的名称(例如"CPU Load")。可以使用
Label设置事件类的标签。- 返回:
-
标签,或者
null如果没有设置标签 - 参见:
-
getId
public long getId()返回 Java 虚拟机 (JVM) 中此事件类型的唯一 ID。- 返回:
- JVM 中使用的 ID
-
getAnnotationElements
返回此事件类型的不可变注解元素列表。- 返回:
-
不可变的注释列表或空列表(如果不存在注释),而不是
null
-
isEnabled
public boolean isEnabled()如果事件已启用且至少有一个记录正在运行,则返回true,否则返回false。默认情况下,该事件是启用的。可以通过以编程方式或使用配置文件将启用设置设置为
true或false来启用或禁用该事件。也可以通过使用@Enabled(false)注释注释事件来禁用该事件。- 返回:
- 如果启用事件,则为 true,否则为 false
- 参见:
-
getDescription
返回描述事件类的短句。可以使用
Description设置事件类的描述。- 返回:
-
描述,或者
null如果不存在描述 - 参见:
-
getAnnotation
如果直接存在具有相同名称的注解元素,则返回指定类型的第一个注释,否则返回null。- 类型参数:
A- 要查询并返回(如果存在)的注释类型- 参数:
annotationClass- 与注释类型对应的Class对象,而不是null- 返回:
-
如果直接存在,则此元素针对指定注释类型的注解,否则为
null
-
getEventType
返回事件类的事件类型,如果不存在则返回null。- 参数:
eventClass- 事件类,而不是null- 返回:
- 事件类,如果类不存在则为 null
- 抛出:
IllegalArgumentException- 如果eventClass是一个抽象类IllegalStateException- 如果类用Registered(false)注释,但没有手动注册
-
getSettingDescriptors
返回描述此事件类型的可用事件设置的设置描述符的不可变列表。- 返回:
-
此事件类型的设置描述符列表,而不是
null
-
getCategoryNames
返回构成此事件类型类别的人类可读名称列表(例如,"Java Application"、"Statistics")。- 返回:
-
类别名称的不可变列表,如果未设置类别,则为名称为
"Uncategorized"的列表 - 参见:
-