OpenJDK 1.23 · jdk.management.jfr.EventTypeInfo · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final List<String>	categoryNames
private final String	description
private final long	id
private final String	label
private final String	name
private final List<SettingDescriptorInfo>	settingDescriptors

Access	Constructor and Description
pack-priv	EventTypeInfo(EventType eventType)
private	EventTypeInfo(CompositeData cd)

Method Summary

Modifier and Type	Method and Description
private static List<String>	createCategoryNames(Object[] array)
private static List<SettingDescriptorInfo>	createSettingDescriptors(Object settings)
private static List<SettingDescriptorInfo>	creatingSettingDescriptorInfos(EventType eventType)
public static EventTypeInfo	Returns: an `EventTypeInfo`, or `null` if `cd` is `null` from(CompositeData `CompositeData` representing the `EventTypeInfo` to return cd) Returns an `EventType` represented by the specified `CompositeData` The supplied `CompositeData` must have the following item names and item types to be valid.
public List<String>	Returns: an immutable list of category names, or a list with the name `"Uncategorized"` if no category has been set getCategoryNames() Returns the list of human-readable names that makes up the category for this `EventTypeInfo` (for example, `"Java Virtual Machine"` or `"Garbage Collector"`).
public String	Returns: the description, or `null` if no description exists getDescription() Returns a short sentence or two describing the event type associated with this `EventTypeInfo`, for example `"Garbage collection performed by the JVM""`.
public long	Returns: the ID 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.
public String	Returns: the label, or `null` if a label is not set getLabel() Returns the label, a human-readable name, associated with the event type for this `EventTypeInfo` (for example, `"Garbage Collection"`).
public String	Returns: the name, not `null` getName() Returns the name for the event type associated with this `EventTypeInfo` (for example, `"jdk.GarbageCollection"`).
public List<SettingDescriptorInfo>	Returns: the settings, not `null` getSettingDescriptors() Returns settings for the event type associated with this `EventTypeInfo`.
public String	Returns: description, not `null` toString() Overrides java.lang.Object.toString. Returns a description of this `EventTypeInfo`.

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

categoryNames	back to summary
private final List<String> categoryNames

description	back to summary
private final String description

id	back to summary
private final long id

label	back to summary
private final String label

name	back to summary
private final String name

settingDescriptors	back to summary
private final List<SettingDescriptorInfo> settingDescriptors

EventTypeInfo	back to summary
pack-priv EventTypeInfo(EventType eventType)

EventTypeInfo	back to summary
private EventTypeInfo(CompositeData cd)

Method Detail

createCategoryNames	back to summary
private static List<String> createCategoryNames(Object[] array)

createSettingDescriptors	back to summary
private static List<SettingDescriptorInfo> createSettingDescriptors(Object settings)

creatingSettingDescriptorInfos	back to summary
private static List<SettingDescriptorInfo> creatingSettingDescriptorInfos(EventType eventType)

from back to summary

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

Parameters

cd:CompositeData: CompositeData representing the EventTypeInfo to return

Returns:EventTypeInfo

an EventTypeInfo, or null if cd is null

Exceptions

IllegalArgumentException:: if cd does not represent a valid EventTypeInfo

getCategoryNames back to summary

getCategoryNames	back to summary
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:List<String> an immutable list of category names, or a list with the name `"Uncategorized"` if no category has been set See Also `EventType#getCategoryNames()`, `Category`

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:List<String>: an immutable list of category names, or a list with the name "Uncategorized" if no category has been set
See Also: EventType#getCategoryNames(), Category

getDescription back to summary

getDescription	back to summary
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:String the description, or `null` if no description exists See Also `EventType#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:String: the description, or null if no description exists
See Also: EventType#getDescription()

getId back to summary

getId	back to summary
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:long the ID See Also `EventType#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:long: the ID
See Also: EventType#getId()

getLabel back to summary

getLabel	back to summary
public String getLabel() Returns the label, a human-readable name, associated with the event type for this `EventTypeInfo` (for example, `"Garbage Collection"`). Returns:String the label, or `null` if a label is not set See Also `EventType#getLabel()`

public String getLabel()

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

Returns:String: the label, or null if a label is not set
See Also: EventType#getLabel()

getName back to summary

getName	back to summary
public String getName() Returns the name for the event type associated with this `EventTypeInfo` (for example, `"jdk.GarbageCollection"`). Returns:String the name, not `null` See Also `EventType#getName()`

public String getName()

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

Returns:String: the name, not null
See Also: EventType#getName()

getSettingDescriptors back to summary

getSettingDescriptors	back to summary
public List<SettingDescriptorInfo> getSettingDescriptors() Returns settings for the event type associated with this `EventTypeInfo`. Returns:List<SettingDescriptorInfo> the settings, not `null` See Also `EventType#getSettingDescriptors()`

public List<SettingDescriptorInfo> getSettingDescriptors()

Returns settings for the event type associated with this EventTypeInfo.

Returns:List<SettingDescriptorInfo>: the settings, not null
See Also: EventType#getSettingDescriptors()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a description of this `EventTypeInfo`. Returns:String description, not `null` Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a description of this EventTypeInfo.

Returns:String

description, not null

Annotations

@Override

public final Class EventTypeInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail