OpenJDK 27 · jdk.management.jfr.ConfigurationInfo · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final String	contents
private final String	description
private final String	label
private final String	name
private final String	provider
private final Map<String, String>	settings

Access	Constructor and Description
pack-priv	ConfigurationInfo(Configuration config)
private	ConfigurationInfo(CompositeData cd)

Method Summary

Modifier and Type	Method and Description
private static Map<String, String>	createMap(Object o)
public static ConfigurationInfo	Returns: a `ConfigurationInfo` object represented by `cd` if `cd` is not `null`, `null` otherwise from(CompositeData `CompositeData` representing a `ConfigurationInfo` cd) Returns a `ConfigurationInfo` object represented by the specified `CompositeData`.
public String	Returns: contents, or `null` if doesn't exist getContents() Returns the textual representation of the configuration associated with this `ConfigurationInfo`, typically the contents of the configuration file that was used to create the configuration.
public String	Returns: the description, or `null` if doesn't exist getDescription() Returns a short sentence that describes the configuration associated with this `ConfigurationInfo` (for example, `"Low overhead configuration safe for continuous use in production environments"`.
public String	Returns: the label, or `null` if doesn't exist getLabel() Returns the human-readable name (for example, `"Continuous"` or `"Profiling"`) for the configuration associated with this `ConfigurationInfo`
public String	Returns: the name, or `null` if doesn't exist getName() Returns the name of the configuration associated with this `ConfigurationInfo` (for example, `"default"`).
public String	Returns: the provider, or `null` if doesn't exist getProvider() Returns the provider of the configuration associated with this `ConfigurationInfo` (for example, `"OpenJDK"`).
public Map<String, String>	Returns: a `Map` with settings, not `null` getSettings() Returns the settings for the configuration associated with this `ConfigurationInfo`.
public String	Returns: the description of the configuration, not `null` toString() Overrides java.lang.Object.toString. Returns a description of the configuration that is associated with this `ConfigurationInfo`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

contents	back to summary
private final String contents

description	back to summary
private final String description

label	back to summary
private final String label

name	back to summary
private final String name

provider	back to summary
private final String provider

settings	back to summary
private final Map<String, String> settings

ConfigurationInfo	back to summary
pack-priv ConfigurationInfo(Configuration config)

ConfigurationInfo	back to summary
private ConfigurationInfo(CompositeData cd)

Method Detail

createMap	back to summary
private static Map<String, String> createMap(Object o)

from back to summary

public static ConfigurationInfo from(CompositeData cd)

Returns a ConfigurationInfo object represented by the specified CompositeData.

The following table shows the required attributes that the specified CompositeData must contain.

Required names and types for CompositeData

Name Type

name String

label String

description String

provider String

contents String

settings javax.management.openmbean.TabularData with a TabularType with the keys "key" and "value", both of the String type

Parameters

cd:CompositeData: CompositeData representing a ConfigurationInfo

Returns:ConfigurationInfo

a ConfigurationInfo object represented by cd if cd is not null, null otherwise

Exceptions

IllegalArgumentException:: if cd does not represent a ConfigurationInfo with the required attributes

getContents back to summary

getContents	back to summary
public String getContents() Returns the textual representation of the configuration associated with this `ConfigurationInfo`, typically the contents of the configuration file that was used to create the configuration. Returns:String contents, or `null` if doesn't exist See Also `Configuration#getContents()`

public String getContents()

Returns the textual representation of the configuration associated with this ConfigurationInfo, typically the contents of the configuration file that was used to create the configuration.

Returns:String: contents, or null if doesn't exist
See Also: Configuration#getContents()

getDescription back to summary

getDescription	back to summary
public String getDescription() Returns a short sentence that describes the configuration associated with this `ConfigurationInfo` (for example, `"Low overhead configuration safe for continuous use in production environments"`. Returns:String the description, or `null` if doesn't exist

public String getDescription()

Returns a short sentence that describes the configuration associated with this ConfigurationInfo (for example, "Low overhead configuration safe for continuous use in production environments".

Returns:String: the description, or null if doesn't exist

getLabel back to summary

getLabel	back to summary
public String getLabel() Returns the human-readable name (for example, `"Continuous"` or `"Profiling"`) for the configuration associated with this `ConfigurationInfo` Returns:String the label, or `null` if doesn't exist See Also `Configuration#getLabel()`

public String getLabel()

Returns the human-readable name (for example, "Continuous" or "Profiling") for the configuration associated with this ConfigurationInfo

Returns:String: the label, or null if doesn't exist
See Also: Configuration#getLabel()

getName back to summary

getName	back to summary
public String getName() Returns the name of the configuration associated with this `ConfigurationInfo` (for example, `"default"`). Returns:String the name, or `null` if doesn't exist See Also `Configuration#getLabel()`

public String getName()

Returns the name of the configuration associated with this ConfigurationInfo (for example, "default").

Returns:String: the name, or null if doesn't exist
See Also: Configuration#getLabel()

getProvider back to summary

getProvider	back to summary
public String getProvider() Returns the provider of the configuration associated with this `ConfigurationInfo` (for example, `"OpenJDK"`). Returns:String the provider, or `null` if doesn't exist See Also `Configuration#getProvider()`

public String getProvider()

Returns the provider of the configuration associated with this ConfigurationInfo (for example, "OpenJDK").

Returns:String: the provider, or null if doesn't exist
See Also: Configuration#getProvider()

getSettings back to summary

getSettings	back to summary
public Map<String, String> getSettings() Returns the settings for the configuration associated with this `ConfigurationInfo`. Returns:Map<String, String> a `Map` with settings, not `null` See Also `Configuration#getSettings()`

public Map<String, String> getSettings()

Returns the settings for the configuration associated with this ConfigurationInfo.

Returns:Map<String, String>: a Map with settings, not null
See Also: Configuration#getSettings()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a description of the configuration that is associated with this `ConfigurationInfo`. Returns:String the description of the configuration, not `null` Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a description of the configuration that is associated with this ConfigurationInfo.

Returns:String

the description of the configuration, not null

Annotations

@Override

public final Class ConfigurationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail