Класс SettingDescriptorInfo
- java.lang.Object
-
- jdk.management.jfr.SettingDescriptorInfo
public final class SettingDescriptorInfo extends Object
Класс управления, описывающий настройку, например, имя, описание и значение по умолчанию.
- Since:
- 9
- См. также:
EventType.getSettingDescriptors()
Методы
| Модификатор и тип | Метод | Описание |
|---|---|---|
static SettingDescriptorInfo |
from(CompositeData cd) |
Возвращает |
String |
getContentType() |
Возвращает тип содержимого настройки, связанной с этим |
String |
getDefaultValue() |
Возвращает значение по умолчанию настройки, связанной с этим |
String |
getDescription() |
Возвращает описание настройки, связанной с этим |
String |
getLabel() |
Возвращает имя настройки в удобочитаемом формате, связанной с этим |
String |
getName() |
Возвращает имя настройки, связанной с этим |
String |
getTypeName() |
Возвращает имя типа настройки, связанной с этим |
String |
toString() |
Возвращает описание этого |
Методы, объявленные в классе 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 должен иметь следующие имена и типы элементов, чтобы быть допустимым.
| Имя | Тип |
|---|---|
| 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.
© 1993, 2020, 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/11/docs/api/jdk.management.jfr/jdk/management/jfr/SettingDescriptorInfo.html
