- java.lang.Object
-
- jdk.jfr.EventType
-
public final class EventType extends Object
イベント、フィールド、設定、注釈を記述します。- 導入されたバージョン:
- 9
-
-
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 <A extends Annotation>
AgetAnnotation(Class<A> annotationClass)
同じ名前の注釈要素が直接存在する場合は、指定された型の最初の注釈を返し、それ以外の場合はnull
を返します。List<AnnotationElement>
getAnnotationElements()
このイベント・タイプの注釈要素の不変なリストを返します。List<String>
getCategoryNames()
"Javaアプリケーション"、"統計"など、このイベント・タイプのカテゴリを構成する人間が判読可能な名前のリストを返します。String
getDescription()
イベント・クラスを表す短い文を返します。static EventType
getEventType(Class<? extends Event> eventClass)
イベント・クラスのイベント・タイプを返します。存在しない場合はnull
を返します。ValueDescriptor
getField(String name)
指定された名前のフィールドを返します。存在しない場合はnull
を返します。List<ValueDescriptor>
getFields()
このイベント・タイプのイベント・フィールドを記述する記述子の不変なリストを返します。long
getId()
JVM内のイベントの一意のIDを返します。String
getLabel()
人間が判読可能な名前を返します(例:"CPU Load"
)。String
getName()
"jdk.jfr.CPULoad"
のように、イベントの識別子を返します。List<SettingDescriptor>
getSettingDescriptors()
このEventType
の利用可能なイベント設定を記述する設定記述子の不変のリストを返します。boolean
isEnabled()
イベントが有効で、少なくとも1つの記録が実行されている場合はtrue
を返し、それ以外の場合はfalse
を返します。
-
-
-
メソッドの詳細
-
getFields
public List<ValueDescriptor> getFields()
このイベント・タイプのイベント・フィールドを記述する記述子の不変なリストを返します。- 戻り値:
null
ではなく、フィールド記述子のリスト
-
getField
public ValueDescriptor getField(String name)
指定された名前のフィールドを返します。存在しない場合はnull
を返します。- 戻り値:
- フィールドを記述する値デスクリプタ、または指定された名前のフィールドが存在しない場合は
null
-
getName
public String getName()
"jdk.jfr.CPULoad"
のように、イベントの識別子を返します。Name
注釈を使用して設定されていない場合、名前はイベント・クラスの完全修飾名です。- 戻り値:
null
ではなく名前- 関連項目:
Name
-
getLabel
public String getLabel()
人間が判読可能な名前を返します(例:"CPU Load"
)。イベント・クラスのラベルは、
Label
で設定できます。- 戻り値:
- ラベル、またはラベルが設定されていない場合は
null
- 関連項目:
Label
-
getId
public long getId()
JVM内のイベントの一意のIDを返します。- 戻り値:
- id
-
getAnnotationElements
public List<AnnotationElement> getAnnotationElements()
このイベント・タイプの注釈要素の不変なリストを返します。- 戻り値:
- 注釈の不変のリスト、または注釈が存在しない場合は
null
ではなく、空のリストです。
-
isEnabled
public boolean isEnabled()
イベントが有効で、少なくとも1つの記録が実行されている場合はtrue
を返し、それ以外の場合はfalse
を返します。デフォルトではイベントは有効ですが、
@Enabled(false)
を使用してイベントに注釈を付けることで動作を変更できます。 有効にするには、"enabled"設定を"true"または"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
-null
ではなく、注釈型に対応するClass
オブジェクト- 戻り値:
- 指定された注釈型のこの要素注釈(存在する場合)、そうでない場合は
null
-
getEventType
public static EventType getEventType(Class<? extends Event> eventClass)
イベント・クラスのイベント・タイプを返します。存在しない場合はnull
を返します。- パラメータ:
eventClass
-null
ではなくイベント・クラス- 戻り値:
- イベント・クラス、またはclassが使用できない場合はnull
- 例外:
IllegalArgumentException
-eventClass
が抽象クラスの場合IllegalStateException
- クラスにRegistered(false)
の注釈が付けられていても、手動で登録されていない場合
-
getSettingDescriptors
public List<SettingDescriptor> getSettingDescriptors()
このEventType
の利用可能なイベント設定を記述する設定記述子の不変のリストを返します。- 戻り値:
null
ではなく、このイベント・タイプの設定記述子のリスト
-
-