モジュール jdk.management.jfr

パッケージ jdk.management.jfr

クラスRecordingInfo

java.lang.Object

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に関連付けられたレコーディングの必要な期間(秒単位)を返します。期間が設定されていない場合は、0を返します。
long	getId()	このRecordingInfoに関連付けられたレコーディングの一意のIDを返します。
long	getMaxAge()	ディスクに保持するデータの秒数を返します。永久にデータを保持する場合は0を返します。
long	getMaxSize()	データ量をバイト単位で測定し、このRecordingInfoに関連付けられているレコーディングをディスクに保存しておくか、データを無期限に保持する場合は0を返します。
String	getName()	このRecordingInfoに関連付けられているレコーディングの名前を返します。
Map<String,String>	getSettings()	このRecordingInfoに関連付けられたレコーディングの設定を返します。
long	getSize()	このRecordingInfoに関連付けられている、記録によって記録された量データを返します。
long	getStartTime()	このRecordingInfoに関連付けられた記録の開始時間(エポック以降のミリ秒として測定)を返します。記録が開始されていない場合はnullを返します。
String	getState()	このRecordingInfoに関連付けられたレコーディングの状態のString表現を返します。
long	getStopTime()	このRecordingInfoに関連付けられたレコーディングの実際のまたは予想される停止時間をエポックからmsで測定します。予想停止時間または実際の停止時間がわからない場合はnullを返します。レコーディングがまだ停止していない場合にのみ発生します。
boolean	isToDisk()	メモリー・バッファが一杯になったときにRecordingInfoに関連付けられているレコーディングをディスクにフラッシュする必要がある場合はtrue、そうでない場合はfalseを返します。
String	toString()	このRecordingInfoに関連付けられたレコーディングの文字列の説明を返します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

メソッドの詳細

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、それ以外の場合はfalse

関連項目:

• Recording.getDumpOnExit()

getMaxAge

public long getMaxAge()

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

インメモリー・レコーディングは最大経過時間の影響を受けません。

戻り値:

データをディスクに保存する期間(秒単位)

関連項目:

• Recording.getMaxAge()
• Recording.setToDisk(boolean)

getMaxSize

public long getMaxSize()

データ量をバイト単位で測定し、このRecordingInfoに関連付けられているレコーディングをディスクに保存しておくか、データを無期限に保持する場合は0を返します。

インメモリー・レコーディングは最大サイズの影響を受けません。

戻り値:

データ量はディスク上にバイト単位で保持する必要があります

関連項目:

• Recording.setToDisk(boolean)
• Recording.getMaxSize()

getState

public String getState()

このRecordingInfoに関連付けられたレコーディングの状態のString表現を返します。

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

戻り値:

nullではなく、レコーディング状態

関連項目:

• Enum.toString()
• Recording.getState()

getStartTime

public long getStartTime()

この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に関連付けられたレコーディングの必要な期間(秒単位)を返します。期間が設定されていない場合は、0を返します。

戻り値:

必要な期間、または期間が設定されていない場合は0

関連項目:

• Recording.getDuration()

from

public static RecordingInfo from(CompositeData cd)

指定されたCompositeDataオブジェクトによって表されるRecordingInfoを返します。

指定したCompositeDataには、次のアイテム名およびアイテム・タイプが有効になる必要があります。

指定されたCompositeDataオブジェクトでサポートされている名前と型

名前	型
id	Long
name	String
state	String
dumpOnExit	Boolean
size	Long
toDisk	Boolean
maxAge	Long
maxSize	Long
startTime	Long
stopTime	Long
宛先	String
duration	Long
settings	要素タイプがSettingDescriptorInfo.from(javax.management.openmbean.CompositeData)メソッドで指定されたSettingDescriptorInfoのマップされた型であるjavax.management.openmbean.CompositeData[]。

パラメータ:

cd - 返すRecordingInfoを表すCompositeData

戻り値:

cdで表されるRecordingInfo、またはcdがnullであればnull

例外:

IllegalArgumentException - cdが有効なRecordingInfoを表していない場合