Класс 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 - если это не действительный файл записи, или произошла ошибка ввода-вывода; NoSuchFileException - если файл file не может быть найден; SecurityException - если существует менеджер безопасности и его метод checkRead запрещает чтение файла.

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

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, которую нельзя разобрать; SecurityException - если существует менеджер безопасности и его метод checkWrite запрещает запись в файл
С момента:: 19

readAllEvents

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

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

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

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

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

© 1993, 2023, 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/21/docs/api/jdk.jfr/jdk/jfr/consumer/RecordingFile.html