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

クラスRecordingInfo


  • public final class RecordingInfo
extends Object
    Recordingの管理表現。
    導入されたバージョン:
    9
    関連項目:
    Recording

    • メソッドのサマリー

      すべてのメソッド 静的メソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      static RecordingInfo from​(CompositeData cd)
      指定されたCompositeDataで表されるRecordingInfoを返します。
      String getDestination​()
      このRecordingInfoに関連付けられた記録のデータを記録終了時に書き込む先のパスを返します。記録を書き込まない場合はnullを返します。
      boolean getDumpOnExit​()
      JVMが終了したときに、このRecordingInfoに関連付けられた記録をファイルにダンプするかどうかを返します。
      long getDuration​()
      持続時間が設定されていない場合、このRecordingInfoまたは {code 0} に関連付けられた記録の希望の持続時間を秒単位で返します。
      long getId​()
      このRecordingInfoに関連付けられた記録の一意のIDを返します。
      long getMaxAge​()
      ディスクに保持するデータの秒数を返します。永久にデータを保持する場合は0を返します。
      long getMaxSize​()
      このRecordingInfoに関連付けられた記録のバイト単位のデータ量を返します。ディスクを回転させる前にディスクに保存するか、データを無期限に保存するかを {code 0} にします。
      String getName​()
      このRecordingInfoに関連付けられているレコーディングの名前を返します。
      Map<String,String> getSettings​()
      このRecordingInfoに関連付けられた記録の設定を返します。
      long getSize​()
      記録によって記録されたデータ量を返します。このRecordingInfoに関連付けられています。
      long getStartTime​()
      エポックからmsとして測定された、このRecordingInfoに関連付けられたレコーディングの開始時間を返します。レコーディングが開始していない場合は、nullを返します。
      String getState​()
      このRecordingInfoに関連付けられた記録の状態のString表現を返します。
      long getStopTime​()
      このRecordingInfoに関連付けられた記録の実際のまたは予想される停止時間をエポックからmsで測定します。予想停止時間または実際の停止時間がわからない場合はnullを返します。記録がまだ停止していない場合にのみ発生します。
      boolean isToDisk​()
      このRecordingInfoに関連するレコーディングが、メモリー・バッファがいっぱいになるとディスクにフラッシュする必要がある場合はtrueを返し、それ以外の場合はfalseを返します。
      String toString​()
      このRecordingInfoに関連付けられた記録の文字列の説明を返します。

    • メソッドの詳細

      • getName

        public String getName​()
        このRecordingInfoに関連付けられているレコーディングの名前を返します。
        戻り値:
        nullではなく、記録名
        関連項目:
        Recording.getName()

      • getId

        public long getId​()
        このRecordingInfoに関連付けられた記録の一意のIDを返します。
        戻り値:
        記録ID
        関連項目:
        Recording.getId()

      • getDumpOnExit

        public boolean getDumpOnExit​()
        JVMが終了したときに、このRecordingInfoに関連付けられた記録をファイルにダンプするかどうかを返します。
        戻り値:
        終了時に記録をダンプする必要がある場合はtrue、それ以外の場合はfalse
        関連項目:
        Recording.getDumpOnExit()

      • getMaxAge

        public long getMaxAge​()
        ディスクに保持するデータの秒数を返します。永久にデータを保持する場合は0を返します。

        イン・メモリー記録は、最大年齢の影響を受けません。

        戻り値:
        データをディスクに保存する期間(秒単位)
        関連項目:
        Recording.getMaxAge(), Recording.setToDisk(boolean)

      • getMaxSize

        public long getMaxSize​()
        このRecordingInfoに関連付けられた記録のバイト単位のデータ量を返します。ディスクを回転させる前にディスクに保存するか、データを無期限に保存するかを {code 0} にします。

        イン・メモリー記録は最大サイズの影響を受けません。

        戻り値:
        データ量はディスク上にバイト単位で保持する必要があります
        関連項目:
        Recording.setToDisk(boolean), Recording.getMaxSize()

      • getState

        public String getState​()
        このRecordingInfoに関連付けられた記録の状態のString表現を返します。

        有効な戻り値は、NEW、DELAYED、STARTING、RUNNING、STOPPING、STOPEEDおよびCLOSEDです。

        戻り値:
        nullではなく、記録状態
        関連項目:
        Enum.toString(), Recording.getState()

      • getStartTime

        public long getStartTime​()
        エポックからmsとして測定された、このRecordingInfoに関連付けられたレコーディングの開始時間を返します。レコーディングが開始していない場合は、nullを返します。
        戻り値:
        記録の開始時間、または記録が開始されていない場合はnull
        関連項目:
        Recording.getStartTime()

      • getStopTime

        public long getStopTime​()
        このRecordingInfoに関連付けられた記録の実際のまたは予想される停止時間をエポックからmsで測定します。予想停止時間または実際の停止時間がわからない場合はnullを返します。記録がまだ停止していない場合にのみ発生します。
        戻り値:
        記録の停止時間、または記録が停止していない場合はnull。
        関連項目:
        Recording.getStopTime()

      • getSettings

        public Map<String,String> getSettings​()
        このRecordingInfoに関連付けられた記録の設定を返します。
        戻り値:
        nullではなく、記録設定
        関連項目:
        Recording.getSettings()

      • getDestination

        public String getDestination​()
        このRecordingInfoに関連付けられた記録のデータを記録終了時に書き込む先のパスを返します。記録を書き込まない場合はnullを返します。
        戻り値:
        宛先、または設定されていない場合はnull
        関連項目:
        Recording.getDestination()

      • toString

        public String toString​()
        このRecordingInfoに関連付けられた記録の文字列の説明を返します。
        オーバーライド:
        toString 、クラス:  Object
        戻り値:
        nullではなく、説明

      • getSize

        public long getSize​()
        記録によって記録されたデータ量を返します。このRecordingInfoに関連付けられています。
        戻り値:
        記録されたデータ量(バイト単位)

      • isToDisk

        public boolean isToDisk​()
        このRecordingInfoに関連するレコーディングが、メモリー・バッファがいっぱいになるとディスクにフラッシュする必要がある場合はtrueを返し、それ以外の場合はfalseを返します。
        戻り値:
        記録がディスクの場合はtrue、それ以外の場合はfalse

      • getDuration

        public long getDuration​()
        持続時間が設定されていない場合、このRecordingInfoまたは {code 0} に関連付けられた記録の希望の持続時間を秒単位で返します。
        戻り値:
        希望期間、または期間が設定されていない場合は {code 0}
        関連項目:
        Recording.getDuration()

      • from

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

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

        名 型
        id Long
        name String
        state String
        dumpOnExit Boolean
        size Long
        ディスク Boolean
        maxAge Long
        maxSize Long
        startTime Long
        stopTime Long
        destination String
        duration Long
        設定 要素タイプがSettingDescriptorInfo.from(javax.management.openmbean.CompositeData)メソッドで指定されたSettingDescriptorInfoのマップされた型であるjavax.management.openmbean.CompositeData[]。
        パラメータ:
        cd - 返すRecordingInfoを表すCompositeData
        戻り値:
        cdで表されるRecordingInfo、またはcdがnullであればnull
        例外:
        IllegalArgumentException - cdが有効なRecordingInfoを表していない場合