Class EventTypeInfo

java.lang.Object
jdk.management.jfr.EventTypeInfo
public final class EventTypeInfo extends Object
Management representation of an EventType.
Since:
9
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()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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