APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.management.jfr

public final Class SettingDescriptorInfo

extends Object
Class Inheritance
Imports
java.util.concurrent.Callable, javax.management.openmbean.CompositeData, jdk.jfr.EventType, .SettingDescriptor, jdk.management.jfr.internal.FlightRecorderMXBeanProvider
Management class that describes a setting, for example name, description and default value.
Since
9
See Also
EventType#getSettingDescriptors()

Field Summary

Modifier and TypeField and Description
private final String
contentType

private final String
defaultValue

private final String
description

private final String
label

private final String
name

private final String
typeName

Constructor Summary

AccessConstructor and Description
pack-priv
SettingDescriptorInfo(SettingDescriptor settingDescriptor)

private
SettingDescriptorInfo(CompositeData cd)

Method Summary

Modifier and TypeMethod and Description
public static SettingDescriptorInfo

Returns:

a SettingDescriptorInfo, or null if cd is null
from(CompositeData
CompositeData representing the SettingDescriptorInfo to return
cd)

Returns an SettingDescriptorInfo represented by the specified CompositeData

The supplied CompositeData must have the following item names and item types to be valid.

public String

Returns:

the name of this settings type, not null
getContentType()

Returns the content type of the setting associated this SettingDescriptorInfo (for example, "jdk.jfr.Timespan").

public String

Returns:

default value for this setting, not null
getDefaultValue()

Returns the default value of the setting associated this SettingDescriptorInfo (for example, "20 ms").

public String

Returns:

the description of this setting, not null
getDescription()

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

public String

Returns:

the label for this setting, not null
getLabel()

Returns the human-readable name of the setting associated with this SettingDescriptorInfo (for example, "Threshold").

public String

Returns:

the name of this setting, not null
getName()

Returns the name of the setting associated with this SettingDescriptorInfo (for example, "threshold").

public String

Returns:

the name of this settings type, not null
getTypeName()

Returns the type name of the setting associated this SettingDescriptorInfo (for example, "jdk.settings.Threshold").

public String

Returns:

a string describing this setting, not null
toString()

Overrides java.lang.Object.toString.

Returns a String description of this SettingDescriptorInfo.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

contentTypeback to summary
private final String contentType
defaultValueback to summary
private final String defaultValue
descriptionback to summary
private final String description
labelback to summary
private final String label
nameback to summary
private final String name
typeNameback to summary
private final String typeName

Constructor Detail

SettingDescriptorInfoback to summary
pack-priv SettingDescriptorInfo(SettingDescriptor settingDescriptor)
SettingDescriptorInfoback to summary
private SettingDescriptorInfo(CompositeData cd)

Method Detail

fromback to summary
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

CompositeData representing the SettingDescriptorInfo to return

Returns:SettingDescriptorInfo

a SettingDescriptorInfo, or null if cd is null

Exceptions
IllegalArgumentException:
if cd does not represent a valid EventTypeInfo
getContentTypeback to summary
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:String

the name of this settings type, not null

getDefaultValueback to summary
public String getDefaultValue()

Returns the default value of the setting associated this SettingDescriptorInfo (for example, "20 ms").

Returns:String

default value for this setting, not null

See Also
SettingDescriptor#getDefaultValue()
getDescriptionback to summary
public String getDescription()

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

Returns:String

the description of this setting, not null

getLabelback to summary
public String getLabel()

Returns the human-readable name of the setting associated with this SettingDescriptorInfo (for example, "Threshold").

Returns:String

the label for this setting, not null

getNameback to summary
public String getName()

Returns the name of the setting associated with this SettingDescriptorInfo (for example, "threshold").

Returns:String

the name of this setting, not null

getTypeNameback to summary
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:String

the name of this settings type, not null

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a String description of this SettingDescriptorInfo.

Returns:String

a string describing this setting, not null

Annotations
@Override