Класс 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").

Returns:: название, не null

getLabel

public String getLabel()

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

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

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

getDescription

public String getDescription()

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

"Record event with duration
 above or equal to threshold"

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

Returns:: описание, или 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 если он недоступен.

Returns:

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

See Also:

ContentType

getTypeName

public String getTypeName()

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

Returns:

имя типа, не null

See Also:

getTypeId()

getTypeId

public long getTypeId()

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

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

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

getAnnotation

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

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

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

getAnnotationElements

public List<AnnotationElement> getAnnotationElements()

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

Returns:: список аннотаций, не null

getDefaultValue

public String getDefaultValue()

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

Returns:: значение по умолчанию, не null

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