Spec-Zone.ru › OpenJDK 21

Класс SettingDescriptorInfo

java.lang.Object
jdk.management.jfr.SettingDescriptorInfo
public final class SettingDescriptorInfo extends Object
Класс управления, описывающий настройки, например, имя, описание и значение по умолчанию.
Since:
9
См. также:
  • EventType.getSettingDescriptors()

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

Модификатор и тип Метод Описание
static SettingDescriptorInfo from(CompositeData cd)
Возвращает SettingDescriptorInfo, представленный указанным CompositeData.
String getContentType()
Возвращает тип содержимого настройки, связанной с этим SettingDescriptorInfo (например, "jdk.jfr.Timespan").
String getDefaultValue()
Возвращает значение по умолчанию настройки, связанной с этим SettingDescriptorInfo (например, "20 ms").
String getDescription()
Возвращает описание настройки, связанной с этим SettingDescriptorInfo (например, "The duration an event must exceed to be be recorded").
String getLabel()
Возвращает удобочитаемое имя настройки, связанной с этим SettingDescriptorInfo (например, "Threshold").
String getName()
Возвращает имя настройки, связанной с этим SettingDescriptorInfo (например, "threshold").
String getTypeName()
Возвращает имя типа настройки, связанной с этим SettingDescriptorInfo (например, "jdk.settings.Threshold").
String toString()
Возвращает описание этого SettingDescriptorInfo.

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

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

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

getLabel

public String getLabel()
Возвращает удобочитаемое имя настройки, связанной с этим SettingDescriptorInfo (например, "Threshold").
Возвращает:
метку этой настройки, не null

getName

public String getName()
Возвращает имя настройки, связанной с этим SettingDescriptorInfo (например, "threshold").
Возвращает:
имя этой настройки, не null

getDescription

public String getDescription()
Возвращает описание настройки, связанной с этим SettingDescriptorInfo (например, "The duration an event must exceed to be be recorded").
Возвращает:
описание этой настройки, не null

getTypeName

public String getTypeName()
Возвращает имя типа настройки, связанной с этим SettingDescriptorInfo (например, "jdk.settings.Threshold").

Тип может быть использован для идентификации типа этой настройки.

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

getContentType

public String getContentType()
Возвращает тип содержимого настройки, связанной с этим SettingDescriptorInfo (например, "jdk.jfr.Timespan").

Тип содержимого может использоваться для определения того, как настройку следует отображать в графическом пользовательском интерфейсе.

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

getDefaultValue

public String getDefaultValue()
Возвращает значение по умолчанию настройки, связанной с этим SettingDescriptorInfo (например, "20 ms").
Возвращает:
значение по умолчанию для этой настройки, не null
См. также:
  • SettingDescriptor.getDefaultValue()

from

public static SettingDescriptorInfo from(CompositeData cd)
Возвращает SettingDescriptorInfo , представленный указанным CompositeData.

Переданный CompositeData должен иметь следующие имена и типы элементов, чтобы быть допустимым.

Имя и тип, которые должен содержать указанный CompositeData
Имя Тип
name String
label String
description String
typeName String
contentType String
defaultValue String
Параметры:
cd - CompositeData , представляющий SettingDescriptorInfo для возврата
Возвращает:
SettingDescriptorInfo, или null, если cd является null
Исключения:
IllegalArgumentException - если cd не представляет допустимый EventTypeInfo

toString

public String toString()
Возвращает строковое описание этого SettingDescriptorInfo.
Переопределяет:
toString в классе Object
Возвращает:
строку, описывающую эту настройку, не null

© 1993, 2023, 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/21/docs/api/jdk.management.jfr/jdk/management/jfr/SettingDescriptorInfo.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API