- java.lang.Object
-
- jdk.management.jfr.EventTypeInfo
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EventTypeInfofrom(CompositeData cd)Returns anEventTyperepresented by the specifiedCompositeDataList<String>getCategoryNames()Returns the list of human-readable names that makes up the category for thisEventTypeInfo(for example,"Java Virtual Machine"or"Garbage Collector").StringgetDescription()Returns a short sentence or two describing the event type associated with thisEventTypeInfo, for example"Garbage collection performed by the JVM"".longgetId()Returns the unique ID for the event type associated with thisEventTypeInfo, not guaranteed to be the same for different Java Virtual Machines (JVMs) instances.StringgetLabel()Returns the label, a human-readable name, associated with the event type for thisEventTypeInfo(for example,"Garbage Collection").StringgetName()Returns the name for the event type associated with thisEventTypeInfo(for example,"jdk.GarbageCollection").List<SettingDescriptorInfo>getSettingDescriptors()Returns settings for the event type associated with thisEventTypeInfo.StringtoString()Returns a description of thisEventTypeInfo.
-
-
-
Method Detail
-
getLabel
public String getLabel()
Returns the label, a human-readable name, associated with the event type for thisEventTypeInfo(for example,"Garbage Collection").- Returns:
- the label, or
nullif a label is not set - See Also:
EventType.getLabel()
-
getCategoryNames
public List<String> getCategoryNames()
Returns the list of human-readable names that makes up the category for thisEventTypeInfo(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:
EventType.getCategoryNames(),Category
-
getId
public long getId()
Returns the unique ID for the event type associated with thisEventTypeInfo, not guaranteed to be the same for different Java Virtual Machines (JVMs) instances.- Returns:
- the ID
- See Also:
EventType.getId()
-
getName
public String getName()
Returns the name for the event type associated with thisEventTypeInfo(for example,"jdk.GarbageCollection").- Returns:
- the name, not
null - See Also:
EventType.getName()
-
getDescription
public String getDescription()
Returns a short sentence or two describing the event type associated with thisEventTypeInfo, for example"Garbage collection performed by the JVM"".- Returns:
- the description, or
nullif no description exists - See Also:
EventType.getDescription()
-
getSettingDescriptors
public List<SettingDescriptorInfo> getSettingDescriptors()
Returns settings for the event type associated with thisEventTypeInfo.- Returns:
- the settings, not
null - See Also:
EventType.getSettingDescriptors()
-
toString
public String toString()
Returns a description of thisEventTypeInfo.
-
from
public static EventTypeInfo from(CompositeData cd)
Returns anEventTyperepresented by the specifiedCompositeDataThe supplied
CompositeDatamust have the following item names and item types to be valid.The name and type the specified CompositeData must contain Name Type id Longname Stringlabel Stringdescription Stringcategory ArrayType(1, SimpleType.STRING)settings javax.management.openmbean.CompositeData[]whose element type is the mapped type forSettingDescriptorInfoas specified in theSettingDescriptorInfo.from(javax.management.openmbean.CompositeData)method.- Parameters:
cd-CompositeDatarepresenting theEventTypeInfoto return- Returns:
- an
EventTypeInfo, ornullifcdisnull - Throws:
IllegalArgumentException- ifcddoes not represent a validEventTypeInfo
-
-