Class ConfigurationInfo

java.lang.Object

jdk.management.jfr.ConfigurationInfo

public final class ConfigurationInfo extends Object

Management representation of a Configuration.

Since:

See Also:

Method Summary

Modifier and Type	Method	Description
`static ConfigurationInfo`	`from(CompositeData cd)`	Returns a `ConfigurationInfo` object represented by the specified `CompositeData`.
`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.
`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"`.
`String`	`getLabel()`	Returns the human-readable name (for example, `"Continuous"` or `"Profiling"`) for the configuration associated with this `ConfigurationInfo`
`String`	`getName()`	Returns the name of the configuration associated with this `ConfigurationInfo` (for example, `"default"`).
`String`	`getProvider()`	Returns the provider of the configuration associated with this `ConfigurationInfo` (for example, `"OpenJDK"`).
`Map<String,String>`	`getSettings()`	Returns the settings for the configuration associated with this `ConfigurationInfo`.
`String`	`toString()`	Returns a description of the configuration that is associated with this `ConfigurationInfo`.

Methods declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Method Details

getProvider

public String getProvider()

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

Returns:

the provider, or null if doesn't exist

See Also:

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:

contents, or null if doesn't exist

See Also:

getSettings

public Map<String,String> getSettings()

Returns the settings for the configuration associated with this ConfigurationInfo.

Returns:

a Map with settings, not null

See Also:

getLabel

public String getLabel()

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

Returns:

the label, or null if doesn't exist

See Also:

getName

public String getName()

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

Returns:

the name, or null if doesn't exist

See Also:

getDescription

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:: the description, or null if doesn't exist

from

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

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 representing a ConfigurationInfo
Returns:: a ConfigurationInfo object represented by cd if cd is not null, null otherwise
Throws:: IllegalArgumentException - if cd does not represent a ConfigurationInfo with the required attributes

toString

public String toString()

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

Overrides:: toString in class Object
Returns:: the description of the configuration, not null

© 1993, 2025, 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.