モジュール jdk.jfr
パッケージ jdk.jfr

クラスSettingDescriptor

java.lang.Object
jdk.jfr.SettingDescriptor
public final class SettingDescriptor
extends Object
イベント設定を記述します。
導入されたバージョン:
9

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    <A extends Annotation>
    A    		 getAnnotation​(Class<A> annotationType)
    同じ名前の注釈要素が使用可能な場合は、指定された型の最初の注釈を返します。それ以外の場合はnullを返します。
    List<AnnotationElement> getAnnotationElements()
    この値記述子の注釈要素の不変なリストを返します。
    String getContentType()
    このSettingDescriptorオブジェクトによって表される値の解釈またはフォーマット方法を指定するテキスト識別子を返します。
    String getDefaultValue()
    この設定記述子のデフォルト値を返します。
    String getDescription()
    (例えば"Record event with duration above or equal to threshold")の設定を説明する文を返します。
    String getLabel()
    (たとえば、"Threshold")の設定を説明する判読可能な名前を返します。
    String getName()
    (たとえば、"threshold")設定の名前を返します。
    long getTypeId()
    Java Virtual Machine (JVM)内のタイプの一意のIDを返します。
    String getTypeName()
    この設定記述子に関連付けられている型の完全修飾クラス名を返します。

    クラス java.lang.Objectで宣言されたメソッド

    clone、equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait

  • メソッドの詳細

    • getName

      public String getName()
      (たとえば、"threshold")設定の名前を返します。
      戻り値:
      nullではなく名前

    • getLabel

      public String getLabel()
      (たとえば、"Threshold")の設定を説明する判読可能な名前を返します。

      設定にラベルがない場合、この設定に関連付けられているタイプのラベルが返されるか、存在しない場合はnullが返されます

      戻り値:
      判読可能な名前、または存在しない場合はnull

    • getDescription

      public String getDescription()
      (例えば"Record event with duration above or equal to threshold")の設定を説明する文を返します。

      設定に説明がない場合は、この設定に関連付けられているタイプの説明が返されます。説明が存在しない場合はnullが返されます。

      戻り値:
      説明(存在しない場合はnull)

    • getContentType

      public String getContentType()
      このSettingDescriptorオブジェクトによって表される値の解釈またはフォーマット方法を指定するテキスト識別子を返します。

      たとえば、設定記述子がパーセンテージを表す場合、"0.5"の値が"50%"としてフォーマットされていることをクライアントに"jdk.jfr.Percentage"ヒントを戻します。

      JDKには、次の事前定義済コンテンツ・タイプが用意されています。

      • jdk.jfr.Percentage
      • jdk.jfr.Timespan
      • jdk.jfr.Timestamp
      • jdk.jfr.Frequency
      • jdk.jfr.Flag
      • jdk.jfr.MemoryAddress
      • jdk.jfr.DataAmount
      • jdk.jfr.NetworkAddress

      ユーザー定義コンテンツ・タイプはContentTypeを使用して作成できます。

      設定にコンテンツ・タイプがない場合、この設定に関連付けられているタイプのコンテンツ・タイプが返されます。使用できない場合はnullが返されます。

      戻り値:
      コンテンツ・タイプ(存在しない場合はnull)
      関連項目:
      ContentType

    • getTypeName

      public String getTypeName()
      この設定記述子に関連付けられている型の完全修飾クラス名を返します。
      戻り値:
      nullではなく型名
      関連項目:
      getTypeId()

    • getTypeId

      public long getTypeId()
      Java Virtual Machine (JVM)内のタイプの一意のIDを返します。

      IDがJVMインスタンス間で同じでない可能性があります。

      戻り値:
      型ID (負ではない)

    • getAnnotation

      public <A extends Annotation> A getAnnotation​(Class<A> annotationType)
      同じ名前の注釈要素が使用可能な場合は、指定された型の最初の注釈を返します。それ以外の場合はnullを返します。
      型パラメータ:
      A - 問合せする注釈の型および使用可能な場合に返す
      パラメータ:
      annotationType - nullではなく、注釈型に対応するクラス・オブジェクト
      戻り値:
      指定された注釈型に関するこの要素の注釈(使用可能な場合)、それ以外の場合はnull

    • getAnnotationElements

      public List<AnnotationElement> getAnnotationElements()
      この値記述子の注釈要素の不変なリストを返します。
      戻り値:
      nullではなく、注釈のリスト

    • getDefaultValue

      public String getDefaultValue()
      この設定記述子のデフォルト値を返します。
      戻り値:
      nullではなく、デフォルト値