- 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:
- EventType.getSettingDescriptors()
 
- 
- 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SettingDescriptorInfofrom(CompositeData cd)Returns anSettingDescriptorInforepresented by the specifiedCompositeDataStringgetContentType()Returns the content type of the setting associated thisSettingDescriptorInfo(for example,"jdk.jfr.Timespan").StringgetDefaultValue()Returns the default value of the setting associated thisSettingDescriptorInfo(for example,"20 ms").StringgetDescription()Returns the description of the setting associated thisSettingDescriptorInfo(for example,"The duration an event must exceed to be be recorded").StringgetLabel()Returns the human-readable name of the setting associated with thisSettingDescriptorInfo(for example,"Threshold").StringgetName()Returns the name of the setting associated with thisSettingDescriptorInfo(for example,"threshold").StringgetTypeName()Returns the type name of the setting associated thisSettingDescriptorInfo(for example,"jdk.settings.Threshold").StringtoString()Returns aStringdescription of thisSettingDescriptorInfo.
 
- 
- 
- 
Method Detail- 
getLabelpublic String getLabel() Returns the human-readable name of the setting associated with thisSettingDescriptorInfo(for example,"Threshold").- Returns:
- the label for this setting, not null
 
 - 
getNamepublic String getName() Returns the name of the setting associated with thisSettingDescriptorInfo(for example,"threshold").- Returns:
- the name of this setting, not null
 
 - 
getDescriptionpublic String 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
 
 - 
getTypeNamepublic String 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
 
 - 
getContentTypepublic String 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
 
 - 
getDefaultValuepublic String getDefaultValue() Returns the default value of the setting associated thisSettingDescriptorInfo(for example,"20 ms").- Returns:
- default value for this setting, not null
- See Also:
- SettingDescriptor.getDefaultValue()
 
 - 
frompublic static SettingDescriptorInfo from(CompositeData cd) Returns anSettingDescriptorInforepresented by the specifiedCompositeDataThe supplied CompositeDatamust have the following item names and item types to be valid.The name and type the specified CompositeData must contain Name Type name Stringlabel Stringdescription StringtypeName StringcontentType StringdefaultValue String- Parameters:
- cd-- CompositeDatarepresenting the- SettingDescriptorInfoto return
- Returns:
- a SettingDescriptorInfo, ornullifcdisnull
- Throws:
- IllegalArgumentException- if- cddoes not represent a valid- EventTypeInfo
 
 
- 
 
-