Module openj9.traceformat
Package com.ibm.jvm.trace.format.api

Interface TracePoint

All Known Implementing Classes:
TracePointImpl
public interface TracePoint
Class to represent a tracepoint produced by IBM JVM's trace engine.

  • Field Details

  • Method Details

    • getID

      int getID()
      Returns:
      the numeric sub-identifier of the current tracepoint within the current component. A tracepoint is identified by componentName](containerCompName)].numericID, for example, comp1.14, or comp1(comp2).12.

    • getTimestampMillis

      long getTimestampMillis()
      Returns:
      the GMT time in milliseconds at which this TracePoint was produced.

    • getMicrosecondsCount

      int getMicrosecondsCount()
      Returns:
      the high resolution timer value stored at the time this tracepoint was generated.

    • getRawTime

      BigInteger getRawTime()
      Returns:
      the raw timestamp

    • getFormattedTime

      String getFormattedTime()
      Returns:
      the time in the format ????????

    • getThread

      TraceThread getThread()
      Returns:
      the thread management object that this trace point belongs to.

    • getComponent

      String getComponent()
      Returns:
      the name of the component that produced this TracePoint. A tracepoint is identified by componentName](containerCompName)].numericID, for example, comp1.14, or comp1(comp2).12.

    • getContainerComponent

      String getContainerComponent()
      Returns:
      the name of the container component that produced the current TracePoint, or null if the TracePoint did not have a container component. A tracepoint is identified by componentName](containerCompName)].numericID, for example, comp1.14, or comp1(comp2).12.

    • getFormattedParameters

      String getFormattedParameters()
      Returns:
      a String containing the parameters formatted and interpolated into the TracePoint's formatting template.

    • getParameterFormattingTemplate

      String getParameterFormattingTemplate()
      Returns:
      a String containing the formatting template for this TracePoint.

    • getParameters

      Object[] getParameters()
      Returns:
      an array of objects, with one object per parameter generated by this TracePoint. Returns null if the TracePoint has no parameters, or if parameters were not recorded for this TracePoint.

    • getGroups

      String[] getGroups()
      Returns:
      a list of groups to which this TracePoint belongs, or none if it doesn't belong to any.

    • getLevel

      int getLevel()
      Returns:
      the level of this TracePoint.

    • getType

      String getType()
      Returns:
      the type of this TracePoint, for example, Entry, Exit or Event.