Spec-Zone.ru › OpenJDK 17

Класс RecordingInfo

java.lang.Object
jdk.management.jfr.RecordingInfo
public final class RecordingInfo extends Object
Представление управления Recording.
Since:
9
См. также:
  • Recording

Краткое описание методов

Модификатор и тип Метод Описание
static RecordingInfo from(CompositeData cd)
Возвращает RecordingInfo, представленный указанным объектом CompositeData.
String getDestination()
Возвращает путь назначения, куда данные, для записи, связанной с этим объектом RecordingInfo, должны быть записаны при остановке записи, или null, если запись не должна быть записана.
boolean getDumpOnExit()
Возвращает, должна ли запись, связанная с этим RecordingInfo, быть сохранена в файл при выходе JVM.
long getDuration()
Возвращает желаемую продолжительность, измеряемую в секундах, записи, связанной с этим объектом RecordingInfo, или {code 0}, если продолжительность не установлена.
long getId()
Возвращает уникальный идентификатор записи, связанной с этим RecordingInfo.
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.
long getStopTime()
Возвращает фактическое или ожидаемое время остановки записи, связанной с этим RecordingInfo, измеряемое в мс с момента эпохи, или null, если ожидаемое или фактическое время остановки неизвестно, что может произойти только в том случае, если запись ещё не остановлена.
boolean isToDisk()
Возвращает true, если запись, связанная с этим объектом RecordingInfo, должна быть выгружена на диск, когда буферы памяти полны, 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.
Возвращает:
идентификатор записи
См. также:
  • Recording.getId()

getDumpOnExit

public boolean getDumpOnExit()
Возвращает, следует ли сохранять запись, связанную с этим RecordingInfo, в файл при завершении JVM.
Возвращает:
true если запись должна быть сохранена при выходе, 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.

Допустимые значения возврата: "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, измеряемое в мс с эпохи, или 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()
Возвращает true если запись, связанная с этим RecordingInfo, должна быть записана на диск, когда буферы памяти заполнены, false в противном случае.
Возвращает:
true если запись на диск, false в противном случае

getDuration

public long getDuration()
Возвращает желаемую продолжительность записи, измеряемую в секундах, связанной с этим RecordingInfo, или {code 0}, если продолжительность не установлена.
Возвращает:
желаемую продолжительность или {code 0}, если продолжительность не установлена
См. также:
  • Recording.getDuration()

from

public static RecordingInfo from(CompositeData cd)
Возвращает объект RecordingInfo, представленный указанным объектом CompositeData.

Указанный объект CompositeData должен иметь следующие имена и типы элементов, чтобы быть допустимым.

Поддерживаемые имена и типы в указанном объекте CompositeData
Имя Тип
id Long
name String
state String
dumpOnExit Boolean
size Long
toDisk Boolean
maxAge Long
maxSize Long
startTime Long
stopTime Long
destination String
duration Long
settings javax.management.openmbean.CompositeData[] чьи типы элементов соответствуют сопоставленному типу для SettingDescriptorInfo, как указано в методе SettingDescriptorInfo.from(javax.management.openmbean.CompositeData).
Параметры:
cd - объект CompositeData, представляющий возвращаемый RecordingInfo
Возвращает:
объект RecordingInfo, представленный cd, или null если cd является null.
Исключения:
IllegalArgumentException - если cd не представляет собой допустимый RecordingInfo

© 1993, 2021, 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/17/docs/api/jdk.management.jfr/jdk/management/jfr/RecordingInfo.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API