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

クラスSettingDescriptorInfo

  • public final class SettingDescriptorInfo
extends Object
    名前、説明、デフォルト値などの設定を記述する管理クラス。
    導入されたバージョン:
    9
    関連項目:
    EventType.getSettingDescriptors()

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      static SettingDescriptorInfo from​(CompositeData cd)
      指定されたCompositeDataで表されるSettingDescriptorInfoを返します。
      String getContentType()
      このSettingDescriptorInfo (たとえば、"jdk.jfr.Timespan")に関連付けられた設定のコンテンツ・タイプを返します。
      String getDefaultValue()
      このSettingDescriptorInfo (たとえば、"20 ms")に関連付けられている設定のデフォルト値を返します。
      String getDescription()
      このSettingDescriptorInfo (たとえば、"The duration an event must exceed to be be recorded")に関連付けられた設定の説明を返します。
      String getLabel()
      このSettingDescriptorInfo (たとえば、"Threshold")に関連付けられた判読可能な設定名を返します。
      String getName()
      このSettingDescriptorInfo (たとえば、"threshold")に関連付けられた設定の名前を返します。
      String getTypeName()
      このSettingDescriptorInfo (たとえば、"jdk.settings.Threshold")に関連付けられた設定のタイプ名を返します。
      String toString()
      このSettingDescriptorInfoのStringの説明を返します。

    • メソッドの詳細

      • getLabel

        public String getLabel()
        このSettingDescriptorInfo (たとえば、"Threshold")に関連付けられた判読可能な設定名を返します。
        戻り値:
        nullではなく、この設定のラベル

      • getName

        public String getName()
        このSettingDescriptorInfo (たとえば、"threshold")に関連付けられた設定の名前を返します。
        戻り値:
        nullではなく、この設定の名前

      • getDescription

        public String getDescription()
        このSettingDescriptorInfo (たとえば、"The duration an event must exceed to be be recorded")に関連付けられた設定の説明を返します。
        戻り値:
        この設定の説明、nullではない

      • getTypeName

        public String getTypeName()
        このSettingDescriptorInfo (たとえば、"jdk.settings.Threshold")に関連付けられた設定のタイプ名を返します。

        このタイプは、これがどのタイプの設定であるかを識別するために使用できます。

        戻り値:
        nullではなく、この設定タイプの名前

      • getContentType

        public String getContentType()
        このSettingDescriptorInfo (たとえば、"jdk.jfr.Timespan")に関連付けられた設定のコンテンツ・タイプを返します。

        コンテンツ・タイプを使用して、グラフィカル・ユーザー・インタフェースでの設定のレンダリング方法を決定することができます。

        戻り値:
        nullではなく、この設定タイプの名前

      • getDefaultValue

        public String getDefaultValue()
        このSettingDescriptorInfo (たとえば、"20 ms")に関連付けられている設定のデフォルト値を返します。
        戻り値:
        nullではなく、この設定のデフォルト値
        関連項目:
        SettingDescriptor.getDefaultValue()

      • from

        public static SettingDescriptorInfo from​(CompositeData cd)
        指定されたCompositeDataで表されるSettingDescriptorInfoを返します。

        提供されたCompositeDataには、以下のアイテム名とアイテム・タイプが有効である必要があります。

        指定されたCompositeDataに含める必要がある名前と型
        名 型
        name String
        label String
        description String
        typeName String
        contentType String
        defaultValue String

        パラメータ:
        cd - 返すSettingDescriptorInfoを表すCompositeData
        戻り値:
        SettingDescriptorInfo、またはcdがnullの場合はnull
        例外:
        IllegalArgumentException - cdが有効なEventTypeInfoを表していない場合

      • toString

        public String toString()
        このSettingDescriptorInfoのStringの説明を返します。
        オーバーライド:
        toString 、クラス:  Object
        戻り値:
        nullではなく、この設定を記述する文字列