Класс SettingDescriptor

java.lang.Object

jdk.jfr.SettingDescriptor

public final class SettingDescriptor extends Object

Описывает настройку события.

Начиная с:: 9

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

Модификатор и тип	Метод	Описание
`<A extends Annotation> A`	`getAnnotation(Class<A> annotationType)`	Возвращает первую аннотацию указанного типа, если доступен элемент аннотации с тем же именем; в противном случае возвращает `null`.
`List<AnnotationElement>`	`getAnnotationElements()`	Возвращает неизменяемый список элементов аннотаций для этого дескриптора значения.
`String`	`getContentType()`	Возвращает текстовый идентификатор, указывающий, как интерпретируется или форматируется значение, представленное этим объектом `SettingDescriptor`.
`String`	`getDefaultValue()`	Возвращает значение по умолчанию для этого дескриптора настройки.
`String`	`getDescription()`	Возвращает предложение, описывающее настройку (например, `"Record event with duration above or equal to threshold"`).
`String`	`getLabel()`	Возвращает удобочитаемое имя, описывающее настройку (например, `"Threshold"`).
`String`	`getName()`	Возвращает имя настройки (например, `"threshold"`).
`long`	`getTypeId()`	Возвращает уникальный идентификатор типа в виртуальной машине Java (JVM).
`String`	`getTypeName()`	Возвращает полное имя класса типа, связанного с этим дескриптором настройки.

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

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

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

getName

public String getName()

Возвращает имя настройки (например, "threshold").

Возвращает:: имя, не null

getLabel

public String getLabel()

Возвращает удобочитаемое имя, описывающее настройку (например, "Threshold").

Если у настройки отсутствует метка, возвращается метка типа, связанного с этой настройкой, или null, если она отсутствует

Возвращает:: удобочитаемое имя или null, если оно отсутствует

getDescription

public String getDescription()

Возвращает предложение, описывающее настройку (например,

"Record event with duration
above or equal to threshold"

Если у настройки отсутствует описание, возвращается описание типа, связанного с этой настройкой, или null, если оно отсутствует.

Возвращает:: описание или null, если оно отсутствует

getContentType

public String getContentType()

Возвращает текстовый идентификатор, указывающий, как интерпретируется или форматируется значение, представленное этим объектом SettingDescriptor.

Например, если дескриптор настройки представляет процентное значение, то "jdk.jfr.Percentage" подсказывает клиенту, что значение «0.5» форматируется как «50%».

В JDK предусмотрены следующие предопределённые типы содержимого:

jdk.jfr.Percentage
jdk.jfr.Timespan
jdk.jfr.Timestamp
jdk.jfr.Frequency
jdk.jfr.Flag
jdk.jfr.MemoryAddress
jdk.jfr.DataAmount
jdk.jfr.NetworkAddress

Пользовательские типы содержимого можно создать с помощью ContentType.

Если у настройки отсутствует тип содержимого, возвращается тип содержимого типа, связанного с этой настройкой, или null, если он недоступен.

Возвращает:

тип содержимого или null, если он отсутствует

См. также:

getTypeName

public String getTypeName()

Возвращает полное имя класса типа, связанного с этим дескриптором настройки.

Возвращает:

имя типа, не null

См. также:

getTypeId

public long getTypeId()

Возвращает уникальный идентификатор типа в виртуальной машине Java (JVM).

Идентификатор может различаться в разных экземплярах JVM.

Возвращает:: идентификатор типа, неотрицательный

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType)

Возвращает первую аннотацию указанного типа, если доступен элемент аннотации с тем же именем; в противном случае возвращает null.

Параметры типа:: A — тип аннотации, которую нужно запросить и вернуть, если она доступна
Параметры:: annotationType — объект Class, соответствующий типу аннотации; не null
Возвращает:: аннотацию этого элемента указанного типа, если она доступна; в противном случае — null

getAnnotationElements

public List<AnnotationElement> getAnnotationElements()

Возвращает неизменяемый список элементов аннотаций для этого дескриптора значения.

Возвращает:: список аннотаций, не null

getDefaultValue

public String getDefaultValue()

Возвращает значение по умолчанию для этого дескриптора настройки.

Возвращает:: значение по умолчанию, не null

© 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/SettingDescriptor.html