public final class SettingDescriptorInfo extends Object
Modifier and Type | Method | Description |
---|---|---|
static SettingDescriptorInfo |
from |
Returns an SettingDescriptorInfo represented by the specified CompositeData
|
String |
getContentType() |
Returns the content type of the setting associated this SettingDescriptorInfo (for example, "jdk.jfr.Timespan" ). |
String |
getDefaultValue() |
Returns the default value of the setting associated this SettingDescriptorInfo (for example, "20 ms" ). |
String |
getDescription() |
Returns the description of the setting associated this SettingDescriptorInfo (for example, "The duration an event must exceed to be be recorded" ). |
String |
getLabel() |
Returns the human-readable name of the setting associated with this SettingDescriptorInfo (for example, "Threshold" ). |
String |
getName() |
Returns the name of the setting associated with this SettingDescriptorInfo (for example, "threshold" ). |
String |
getTypeName() |
Returns the type name of the setting associated this SettingDescriptorInfo (for example, "jdk.settings.Threshold" ). |
String |
toString() |
Returns a String description of this SettingDescriptorInfo . |
public String getLabel()
SettingDescriptorInfo
(for example, "Threshold"
).null
public String getName()
SettingDescriptorInfo
(for example, "threshold"
).null
public String getDescription()
SettingDescriptorInfo
(for example, "The duration an event must exceed to be be recorded"
).public String getTypeName()
SettingDescriptorInfo
(for example, "jdk.settings.Threshold"
). The type can be used to identify what type of setting this is.
null
public String getContentType()
SettingDescriptorInfo
(for example, "jdk.jfr.Timespan"
). The content type can be used to determine how the setting should be rendered in a graphical user interface.
null
public String getDefaultValue()
SettingDescriptorInfo
(for example, "20 ms"
).null
public static SettingDescriptorInfo from(CompositeData cd)
SettingDescriptorInfo
represented by the specified CompositeData
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
cd
- CompositeData
representing the SettingDescriptorInfo
to returnSettingDescriptorInfo
, or null
if cd
is null
IllegalArgumentException
- if cd
does not represent a valid EventTypeInfo
public String toString()
String
description of this SettingDescriptorInfo
.
© 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