クラス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 Virtual Machine (JVM)にあるこのイベント・タイプの一意のIDを返します。
    String
    getLabel()
    解読可能な名前(たとえば、"CPU Load")を返します。
    String
    getName()
    イベント(たとえば、"jdk.CPULoad")の識別子を返します。
    List<SettingDescriptor>
    getSettingDescriptors()
    このイベント・タイプの使用可能なイベント設定を記述する設定記述子の不変のリストを返します。
    boolean
    isEnabled()
    イベントが有効化されていて、1つ以上のレコーディングが実行中である場合はtrueを返し、それ以外の場合はfalseを返します。

    クラスオブジェクトで宣言されたメソッド

    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 Virtual Machine (JVM)にあるこのイベント・タイプの一意のIDを返します。
      戻り値:
      JVMで使用されるID

    • getAnnotationElements

      public List<AnnotationElement> getAnnotationElements()
      このイベント・タイプの注釈要素の不変なリストを返します。
      戻り値:
      注釈の不変のリスト、または注釈が存在しない場合は空のリスト、nullは存在しない

    • isEnabled

      public boolean isEnabled()
      イベントが有効化されていて、1つ以上のレコーディングが実行中である場合は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 - nullではなく、注釈型に対応するClassオブジェクト
      戻り値:
      指定された注釈型に対するこの要素の注釈(直接存在する場合)、それ以外の場合は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"という名前のリスト
      関連項目: