Class EventTypeInfo

java.lang.Object

jdk.management.jfr.EventTypeInfo

public final class EventTypeInfo extends Object

Management representation of an EventType.

Since:

See Also:

Method Summary

Modifier and Type	Method	Description
`static EventTypeInfo`	`from(CompositeData cd)`	Returns an `EventType` represented by the specified `CompositeData`
`List<String>`	`getCategoryNames()`	Returns the list of human-readable names that makes up the category for this `EventTypeInfo` (for example, `"Java Virtual Machine"` or `"Garbage Collector"`).
`String`	`getDescription()`	Returns a short sentence or two describing the event type associated with this `EventTypeInfo`, for example `"Garbage collection performed by the JVM"`.
`long`	`getId()`	Returns the unique ID for the event type associated with this `EventTypeInfo`, not guaranteed to be the same for different Java Virtual Machines (JVMs) instances.
`String`	`getLabel()`	Returns the label, a human-readable name, associated with the event type for this `EventTypeInfo` (for example, `"Garbage Collection"`).
`String`	`getName()`	Returns the name for the event type associated with this `EventTypeInfo` (for example, `"jdk.GarbageCollection"`).
`List<SettingDescriptorInfo>`	`getSettingDescriptors()`	Returns settings for the event type associated with this `EventTypeInfo`.
`String`	`toString()`	Returns a description of this `EventTypeInfo`.

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

getLabel

public String getLabel()

Returns the label, a human-readable name, associated with the event type for this EventTypeInfo (for example, "Garbage Collection").

Returns:

the label, or null if a label is not set

See Also:

getCategoryNames

public List<String> getCategoryNames()

Returns the list of human-readable names that makes up the category for this EventTypeInfo (for example, "Java Virtual Machine" or "Garbage Collector").

Returns:

an immutable list of category names, or a list with the name "Uncategorized" if no category has been set

See Also:

getId

public long getId()

Returns the unique ID for the event type associated with this EventTypeInfo, not guaranteed to be the same for different Java Virtual Machines (JVMs) instances.

Returns:

the ID

See Also:

getName

public String getName()

Returns the name for the event type associated with this EventTypeInfo (for example, "jdk.GarbageCollection").

Returns:

the name, not null

See Also:

getDescription

public String getDescription()

Returns a short sentence or two describing the event type associated with this EventTypeInfo, for example "Garbage collection performed by the JVM".

Returns:

the description, or null if no description exists

See Also:

getSettingDescriptors

public List<SettingDescriptorInfo> getSettingDescriptors()

Returns settings for the event type associated with this EventTypeInfo.

Returns:

the settings, not null

See Also:

toString

public String toString()

Returns a description of this EventTypeInfo.

Overrides:: toString in class Object
Returns:: description, not null

from

public static EventTypeInfo from(CompositeData cd)

Returns an EventType 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

id Long

name String

label String

description String

categoryNames ArrayType(1, SimpleType.STRING)

settingDescriptors javax.management.openmbean.CompositeData[] whose element type is the mapped type for SettingDescriptorInfo as specified in the SettingDescriptorInfo.from(CompositeData) method.

The name and type the specified CompositeData must contain
Name	Type
id	`Long`
name	`String`
label	`String`
description	`String`
categoryNames	`ArrayType(1, SimpleType.STRING)`
settingDescriptors	`javax.management.openmbean.CompositeData[]` whose element type is the mapped type for `SettingDescriptorInfo` as specified in the `SettingDescriptorInfo.from(CompositeData)` method.

Parameters:: cd - CompositeData representing the EventTypeInfo to return
Returns:: an EventTypeInfo, or null if cd is null
Throws:: IllegalArgumentException - if cd does not represent a valid EventTypeInfo

© 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.