モジュール jdk.jfr

パッケージ jdk.jfr.consumer

クラスRecordingFile

java.lang.Object

jdk.jfr.consumer.RecordingFile

すべての実装されたインタフェース:

Closeable, AutoCloseable

public final class RecordingFile extends Object implements Closeable

レコーディング・ファイル。

次の例は、レコーディング・ファイル内のすべてのイベントの読込みと印刷の方法を示しています。

try (RecordingFile recordingFile = new RecordingFile(Paths.get("recording.jfr"))) {
    while (recordingFile.hasMoreEvents()) {
        RecordedEvent event = recordingFile.readEvent();
        System.out.println(event);
    }
}

導入されたバージョン:

9

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
RecordingFile(Path file)	レコーディング・ファイルを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
void	close()	このレコーディング・ファイルを閉じて、それに関連するすべてのシステム・リソースを解放します。
boolean	hasMoreEvents()	レコーディング・ファイルに未読イベントが存在する場合true、それ以外の場合はfalseを返します。
static List<RecordedEvent>	readAllEvents(Path path)	ファイル内のすべてのイベントのリストを返します。
RecordedEvent	readEvent()	レコーディング中の次のイベントを読み込みます。
List<EventType>	readEventTypes()	このレコーディングのすべてのイベント・タイプのリストを返します。
void	write(Path destination, Predicate<RecordedEvent> filter)	イベントをフィルタリングして新しいファイルに書き込みます。

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

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

コンストラクタの詳細

RecordingFile

public RecordingFile(Path file) throws IOException

レコーディング・ファイルを作成します。

信頼できるソースからの記録ファイルのみを使用する必要があります。

パラメータ:

file - nullではなくオープンするファイルのパス

例外:

IOException - 有効な記録ファイルでない場合、またはI/Oエラーが発生した場合

NoSuchFileException - fileが見つからないか

SecurityException - セキュリティ・マネージャが存在し、そのcheckReadメソッドがファイルへの読取りアクセスを拒否した場合。

メソッドの詳細

readEvent

public RecordedEvent readEvent() throws IOException

レコーディング中の次のイベントを読み込みます。

戻り値:

nullではなく、次のイベント

例外:

EOFException - レコーディング・ファイルにイベントがこれ以上存在しない場合

IOException - 入出力エラーが発生した場合

関連項目:

• hasMoreEvents()

hasMoreEvents

public boolean hasMoreEvents()

レコーディング・ファイルに未読イベントが存在する場合true、それ以外の場合はfalseを返します。

戻り値:

レコーディングに未読イベントが存在する場合はtrue、そうでない場合はfalse。

readEventTypes

public List<EventType> readEventTypes() throws IOException

このレコーディングのすべてのイベント・タイプのリストを返します。

戻り値:

nullではなく、イベント・タイプのリスト

例外:

IOException - ファイルからの読取り中にI/Oエラーが発生した場合

関連項目:

• hasMoreEvents()

close

public void close() throws IOException

このレコーディング・ファイルを閉じて、それに関連するすべてのシステム・リソースを解放します。

定義:

close、インタフェースAutoCloseable

定義:

close、インタフェースCloseable

例外:

IOException - 入出力エラーが発生した場合

write

public void write(Path destination, Predicate<RecordedEvent> filter) throws IOException

イベントをフィルタリングして新しいファイルに書き込みます。

パラメータ:

destination - nullではなく、新しいファイルが書き込まれるパス

filter - nullではなく、イベントを含めるかどうかを決定するフィルタ

例外:

IOException - I/Oエラーが発生した場合、Flight Recorderファイルまたは解析できないJFRファイルのバージョンではありません

SecurityException - セキュリティ・マネージャが存在し、そのcheckWriteメソッドがファイルへの書込みアクセスを拒否した場合

導入されたバージョン:

19

readAllEvents

public static List<RecordedEvent> readAllEvents(Path path) throws IOException

ファイル内のすべてのイベントのリストを返します。

このメソッドは、すべてのイベントを1回の操作で読み取ると便利な単純なケース用です。 大きなファイルを読み込むためのものではありません。

信頼できるソースからの記録ファイルのみを使用する必要があります。

パラメータ:

path - nullではなく、ファイルへのパス

戻り値:

ファイルからのイベントがListオブジェクトとして表示される

例外:

IOException - I/Oエラーが発生した場合、Flight Recorderファイルまたは解析できないJFRファイルのバージョンではありません

SecurityException - セキュリティ・マネージャが存在し、そのcheckReadメソッドがファイルへの読取りアクセスを拒否した場合。