Class SettingDescriptorInfo

java.lang.Object
jdk.management.jfr.SettingDescriptorInfo
public final class SettingDescriptorInfo extends Object
Management class that describes a setting, for example name, description and default value.
Since:
9
See Also:

Method Summary

Modifier and Type Method Description
static SettingDescriptorInfo from(CompositeData cd)
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.

Methods declared in class java.lang.Object

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

Method Details

getLabel

public String getLabel()
Returns the human-readable name of the setting associated with this SettingDescriptorInfo (for example, "Threshold").
Returns:
the label for this setting, not null

getName

public String getName()
Returns the name of the setting associated with this SettingDescriptorInfo (for example, "threshold").
Returns:
the name of this setting, not null

getDescription

public String getDescription()
Returns the description of the setting associated this SettingDescriptorInfo (for example, "The duration an event must exceed to be be recorded").
Returns:
the description of this setting, not null

getTypeName

public String getTypeName()
Returns the type name of the setting associated this SettingDescriptorInfo (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

public String getContentType()
Returns the content type of the setting associated this 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.

Returns:
the name of this settings type, not null

getDefaultValue

public String getDefaultValue()
Returns the default value of the setting associated this SettingDescriptorInfo (for example, "20 ms").
Returns:
default value for this setting, not null
See Also:

from

public static SettingDescriptorInfo from(CompositeData cd)
Returns an 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
Parameters:
cd - CompositeData representing the SettingDescriptorInfo to return
Returns:
a SettingDescriptorInfo, or null if cd is null
Throws:
IllegalArgumentException - if cd does not represent a valid EventTypeInfo

toString

public String toString()
Returns a String description of this SettingDescriptorInfo.
Overrides:
toString in class Object
Returns:
a string describing this setting, not null

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