Класс ValueDescriptor

java.lang.Object
- jdk.jfr.ValueDescriptor

public final class ValueDescriptor
extends Object

Описание полей событий и элементов аннотаций.

С момента:: 9

Конструкторы

Конструктор	Описание
`ValueDescriptor(Class<?> type, String name)`	Создаёт дескриптор значения, полезный для динамического создания типов событий и аннотаций.
`ValueDescriptor(Class<?> type, String name, List<AnnotationElement> annotations)`	Создаёт дескриптор значения, полезный для динамического создания типов событий и аннотаций.

Методы

Модификатор и тип	Метод	Описание
`<A extends Annotation> A`	`getAnnotation(Class<A> annotationType)`	Возвращает первую аннотацию для указанного типа, если элемент аннотации с тем же именем непосредственно присутствует для этого дескриптора значения, `null` в противном случае.
`List<AnnotationElement>`	`getAnnotationElements()`	Возвращает неизменяемый список элементов аннотаций для этого дескриптора значения.
`String`	`getContentType()`	Возвращает текстовый идентификатор, который определяет, как значение, представленное этим `ValueDescriptor`, интерпретируется или форматируется.
`String`	`getDescription()`	Возвращает предложение, описывающее значение (например, `"Maximum throughput in the transaction system. Value is reset after each new batch."`).
`List<ValueDescriptor>`	`getFields()`	Возвращает неизменяемый список дескрипторов значений, если тип является сложным, иначе — пустой список.
`String`	`getLabel()`	Возвращает удобочитаемое имя, описывающее значение (например, `"Maximum Throughput"`).
`String`	`getName()`	Возвращает имя значения (например, `"maxThroughput"`).
`long`	`getTypeId()`	Возвращает уникальный идентификатор для типа в виртуальной машине Java (JVM).
`String`	`getTypeName()`	Возвращает полное имя класса типа, связанного с этим дескриптором значения.
`boolean`	`isArray()`	Возвращает, является ли этот дескриптор значения типом массива.

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

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

Конструкторы

ValueDescriptor

public ValueDescriptor(Class<?> type,
                       String name)

Создаёт дескриптор значения, полезный для динамического создания типов событий и аннотаций.

Поддерживаются следующие типы:

byte.class
short.class
int.class
long.class
char.class
float.class
double.class
boolean.class
String.class
Class.class
Thread.class

Имя должно быть допустимым идентификатором Java (например, "maxThroughput"). Дополнительную информацию см. в спецификации языка Java 3.8.

Параметры:: type — тип, не null; name — имя, не null
Исключения:: SecurityException — если менеджер безопасности присутствует и у вызывающего объекта нет FlightRecorderPermission("registerEvent")

ValueDescriptor

public ValueDescriptor(Class<?> type,
                       String name,
                       List<AnnotationElement> annotations)

Создаёт дескриптор значения, полезный для динамического создания типов событий и аннотаций.

Поддерживаются следующие типы:

byte.class
short.class
int.class
long.class
char.class
float.class
double.class
boolean.class
String.class
Class.class
Thread.class

Имя должно быть допустимым идентификатором Java (например, "maxThroughput"). Дополнительную информацию см. в спецификации языка Java 3.8.

Параметры:: type — тип, не null; name — имя, не null; annotations — аннотации на дескрипторах значений, не null
Исключения:: SecurityException — если менеджер безопасности присутствует и у вызывающего объекта нет FlightRecorderPermission("registerEvent")

Методы

getLabel

public String getLabel()

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

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

getName

public String getName()

Возвращает имя значения (например, "maxThroughput").

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

getDescription

public String getDescription()

Возвращает предложение, описывающее значение (например, "Maximum throughput in the transaction system. Value is reset after each new batch.").

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

getContentType

public String getContentType()

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

Например, если тип дескриптора значения — float и значение события — 0.5f, тип содержимого "jdk.jfr.Percentage" указывает клиенту, что значение является процентом и должно отображаться как "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 если отсутствует
См. также:: ContentType

getTypeName

public String getTypeName()

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

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

getTypeId

public long getTypeId()

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

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

isArray

public boolean isArray()

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

Возвращает:: true если это тип массива, false в противном случае

getAnnotation

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

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

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

getAnnotationElements

public List<AnnotationElement> getAnnotationElements()

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

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

getFields

public List<ValueDescriptor> getFields()

Возвращает неизменяемый список дескрипторов значений, если тип является сложным, иначе — пустой список.

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