Класс SettingDescriptor

java.lang.Object

jdk.jfr.SettingDescriptor

public final class SettingDescriptor extends Object

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

Since:: 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()`	Возвращает полное имя класса типа, связанного с этим описателем настройки.

Методы, объявленные в классе java.lang.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 в противном случае.

Type Parameters:: 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://download.java.net/java/early_access/jdk24/docs/api/jdk.jfr/jdk/jfr/SettingDescriptor.html