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

クラスValueDescriptor



  • public final class ValueDescriptor
    extends Object
    イベント・フィールドと注釈要素について説明します。
    導入されたバージョン:
    9
    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      ValueDescriptor​(Class<?> type, String name)
      イベント型と注釈を動的に作成するのに簡易な値デスクリプタを作成します。
      ValueDescriptor​(Class<?> type, String name, List<AnnotationElement> annotations)
      イベント型と注釈を動的に作成するのに簡易な値デスクリプタを作成します。
    • コンストラクタの詳細

      • ValueDescriptor

        public ValueDescriptor​(Class<?> type,
                               String name)

        イベント型と注釈を動的に作成するのに簡易な値デスクリプタを作成します。

        サポートされているタイプは次のとおりです

        • byte.class
        • short.class
        • int.class
        • long.class
        • char.class
        • float.class
        • double.class
        • boolean.class
        • String.class
        • Class.class
        • Thread.class

        "maxThroughput"のような有効なJava識別子。 詳細は、3.8 Java言語仕様を参照してください。

        パラメータ:
        type - タイプは、nullではなく
        name - nullではなく名前
        例外:
        SecurityException - セキュリティ・マネージャが存在し、呼び出し元にFlightRecorderPermission("registerEvent")がない場合
      • ValueDescriptor

        public ValueDescriptor​(Class<?> type,
                               String name,
                               List<AnnotationElement> annotations)

        イベント型と注釈を動的に作成するのに簡易な値デスクリプタを作成します。

        サポートされているタイプは次のとおりです

        • byte.class
        • short.class
        • int.class
        • long.class
        • char.class
        • float.class
        • double.class
        • boolean.class
        • String.class
        • Class.class
        • Thread.class

        "maxThroughput"のような有効なJava識別子。 詳細は、3.8 Java言語仕様を参照してください。

        パラメータ:
        type - タイプは、nullではなく
        name - nullではなく名前
        annotations - nullではなく、値記述子に関する注釈
        例外:
        SecurityException - セキュリティ・マネージャが存在し、呼び出し元にFlightRecorderPermission "registerEvent"}がない場合}
    • メソッドの詳細

      • getLabel

        public String getLabel​()
        値を説明する人間が判読可能な名前を返します(例:"Maximum Throughput")。
        戻り値:
        人間が判読可能な名前、または使用できない場合はnull
      • getName

        public String getName​()
        値の名前を返します(例:"maxThroughput")。
        戻り値:
        nullではなく名前
      • getDescription

        public String getDescription​()
        値を説明する文を返します(例:"Maximum throughput in the transaction system. Value is reset after each new batch")。
        戻り値:
        記述、または使用できない場合はnull
      • getContentType

        public String getContentType​()
        このValueDescriptorが表す値がどのように解釈またはフォーマットされるべきかを決定するテキスト識別子を返します。

        たとえば、値の記述子タイプがfloatで、イベント値が0.5fである場合、コンテンツ・タイプ"jdk.jfr.Percentage"は、値がパーセンテージであり、"50%"としてレンダリングされるべきであることをヒントします。

        JDKには、次の定義済みのコンテンツ・タイプが付属しています。

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

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

        戻り値:
        コンテンツ・タイプ、または使用できない場合はnull
        関連項目:
        ContentType
      • getTypeName

        public String getTypeName​()
        この値ディスクリプタに関連付けられた型の完全修飾クラス名を返します。
        戻り値:
        nullではなく型名
        関連項目:
        getTypeId()
      • getTypeId

        public long getTypeId​()
        JVM内の型の一意の識別子を返します。 idは、JVMインスタンス間で同じであることが保証されていません。
        戻り値:
        負ではなく、型ID
      • isArray

        public boolean isArray​()
        この値記述子が配列型の場合はを返します。
        戻り値:
        配列型の場合はtrue、それ以外の場合はfalse
      • getAnnotation

        public <A extends Annotation> A getAnnotation​(Class<A> annotationType)
        この値記述子に同じ名前の注釈要素が直接存在する場合は、指定された型の最初の注釈を返します。それ以外の場合はnullを返します。
        型パラメータ:
        A - 問合せの対象であり、存在する場合に返される注釈の型
        パラメータ:
        annotationType - nullではなく、注釈型に対応するClassオブジェクト
        戻り値:
        指定された注釈型のこの要素注釈(存在する場合)、そうでない場合はnull
      • getAnnotationElements

        public List<AnnotationElement> getAnnotationElements​()
        この値デスクリプタの注釈要素の不変なリストを返します。
        戻り値:
        nullではなく、注釈のリスト
      • getFields

        public List<ValueDescriptor> getFields​()
        型が複雑な場合は値記述子の不変のリストを返し、そうでない場合は空のリストを返します。
        戻り値:
        nullではなく、値記述子のリスト