java.lang.Object
jdk.management.jfr.SettingDescriptorInfo
Management class that describes a setting, for example name, description and
default value.
- Since:
- 9
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic SettingDescriptorInfo
from
(CompositeData cd) Returns anSettingDescriptorInfo
represented by the specifiedCompositeData
Returns the content type of the setting associated thisSettingDescriptorInfo
(for example,"jdk.jfr.Timespan"
).Returns the default value of the setting associated thisSettingDescriptorInfo
(for example,"20 ms"
).Returns the description of the setting associated thisSettingDescriptorInfo
(for example,"The duration an event must exceed to be be recorded"
).getLabel()
Returns the human-readable name of the setting associated with thisSettingDescriptorInfo
(for example,"Threshold"
).getName()
Returns the name of the setting associated with thisSettingDescriptorInfo
(for example,"threshold"
).Returns the type name of the setting associated thisSettingDescriptorInfo
(for example,"jdk.settings.Threshold"
).toString()
Returns aString
description of thisSettingDescriptorInfo
.
-
Method Details
-
getLabel
Returns the human-readable name of the setting associated with thisSettingDescriptorInfo
(for example,"Threshold"
).- Returns:
- the label for this setting, not
null
-
getName
Returns the name of the setting associated with thisSettingDescriptorInfo
(for example,"threshold"
).- Returns:
- the name of this setting, not
null
-
getDescription
Returns the description of the setting associated thisSettingDescriptorInfo
(for example,"The duration an event must exceed to be be recorded"
).- Returns:
- the description of this setting, not null
-
getTypeName
Returns the type name of the setting associated thisSettingDescriptorInfo
(for example,"jdk.settings.Threshold"
).The type can be used to identify what type of setting this is.
- Returns:
- the name of this settings type, not
null
-
getContentType
Returns the content type of the setting associated thisSettingDescriptorInfo
(for example,"jdk.jfr.Timespan"
).The content type can be used to determine how the setting should be rendered in a graphical user interface.
- Returns:
- the name of this settings type, not
null
-
getDefaultValue
Returns the default value of the setting associated thisSettingDescriptorInfo
(for example,"20 ms"
).- Returns:
- default value for this setting, not
null
- See Also:
-
from
Returns anSettingDescriptorInfo
represented by the specifiedCompositeData
The supplied
CompositeData
must have the following item names and item types to be valid.The name and type the specified CompositeData must contain Name Type name String
label String
description String
typeName String
contentType String
defaultValue String
- Parameters:
cd
-CompositeData
representing theSettingDescriptorInfo
to return- Returns:
- a
SettingDescriptorInfo
, ornull
ifcd
isnull
- Throws:
IllegalArgumentException
- ifcd
does not represent a validEventTypeInfo
-
toString
Returns aString
description of thisSettingDescriptorInfo
.
-