Класс 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 если он не существует
См. также:: ContentType

getTypeName

public String getTypeName()

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

Возвращает:: имя типа, не null
См. также:: getTypeId()

getTypeId

public long getTypeId()

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

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

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

getAnnotation

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

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

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

getAnnotationElements

public List<AnnotationElement> getAnnotationElements()

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

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

getDefaultValue

public String getDefaultValue()

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

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