Класс 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)`	Отфильтровывает события и записывает их в новый файл.

Методы, объявленные в классе Object

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

Подробное описание конструкторов

RecordingFile

public RecordingFile(Path file) throws IOException

Создаёт файл записи.

Следует использовать только файлы записи из доверенных источников.

Параметры:: file — путь к открываемому файлу, не null
Исключения:: IOException — если файл записи недействителен или произошла ошибка ввода-вывода; NoSuchFileException — если не удаётся найти file

Подробное описание методов

readEvent

public RecordedEvent readEvent() throws IOException

Читает следующее событие в записи.

Возвращает:

следующее событие, не null

Исключения:

EOFException — если в файле записи больше нет событий

IOException — если произошла ошибка ввода-вывода

См. также:

hasMoreEvents

public boolean hasMoreEvents()

Возвращает true, если в файле записи есть непрочитанные события, и false в противном случае.

Возвращает:: true, если в записи есть непрочитанные события, и false в противном случае.

readEventTypes

public List<EventType> readEventTypes() throws IOException

Возвращает список всех типов событий в этой записи.

Возвращает:

список типов событий, не null

Исключения:

IOException — если при чтении файла произошла ошибка ввода-вывода

См. также:

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 — если произошла ошибка ввода-вывода, файл не является файлом Flight Recorder или это версия файла JFR, которую невозможно обработать
Начиная с версии:: 19

readAllEvents

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

Возвращает список всех событий в файле.

Этот метод предназначен для простых случаев, когда удобно прочитать все события за одну операцию. Он не предназначен для чтения больших файлов.

Следует использовать только файлы записи из доверенных источников.

Параметры:: path — путь к файлу, не null
Возвращает:: события из файла в виде объекта List; возможность изменения объекта List зависит от реализации и поэтому не указана, не null
Исключения:: IOException — если произошла ошибка ввода-вывода, файл не является файлом Flight Recorder или это версия файла JFR, которую невозможно обработать

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.jfr/jdk/jfr/consumer/RecordingFile.html