Module openj9.traceformat

Package com.ibm.jvm.format

Class TracePoint

java.lang.Object

com.ibm.jvm.format.TracePoint

All Implemented Interfaces:

TracePoint, Comparable

public class TracePoint
extends Object
implements Comparable, TracePoint

Constructor Summary

Constructors

Constructor	Description
TracePoint(byte[] rawTracePoint, int length, BigInteger upperWord, long threadID, String fileName, long offsetOfStartOfTracePointInFile, long offsetOfEndOfTracePointInFile, boolean wasFragmented)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object other)	Compares this object with the specified object for order.
String	from()
String	getComponent()
String	getComponentName()
String	getContainerComponent()
String	getContainerComponentName()
String	getFileName()
String	getFormattedParameters()
String	getFormattedTime()
String[]	getGroups()
int	getID()
int	getLevel()
int	getMicrosecondsCount()
long	getNewTimerUpperWord()
long	getOffsetInTraceFile()
String	getParameterDataFormatted()
String	getParameterFormattingTemplate()
Object[]	getParameters()
byte[]	getParmData()
BigInteger	getRawTimeStamp()
long	getThreadID()
long	getTimestampMillis()
int	getTPID()
String	getType()
int	getTypeAsInt()
boolean	isInvalid()
boolean	isLongTracePoint()
boolean	isLostRecord()
boolean	isNormalTracepoint()
boolean	isTimerUpperWord()
int	longTracePointLength()
void	setIsChangeOfThread(boolean isChangeOfThread)
boolean	setTracePointsUpperWord(BigInteger upperWord)

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TracePoint

public TracePoint(byte[] rawTracePoint,
 int length,
 BigInteger upperWord,
 long threadID,
 String fileName,
 long offsetOfStartOfTracePointInFile,
 long offsetOfEndOfTracePointInFile,
 boolean wasFragmented)

Method Details

isLongTracePoint

public boolean isLongTracePoint()

longTracePointLength

public int longTracePointLength()

getFileName

public String getFileName()

getOffsetInTraceFile

public long getOffsetInTraceFile()

getTPID

public int getTPID()

getComponentName

public String getComponentName()

getContainerComponentName

public String getContainerComponentName()

getThreadID

public long getThreadID()

Specified by:

getThreadID in interface TracePoint

Returns:

the thread identifier of the thread that produced this TracePoint.

getParameterDataFormatted

public String getParameterDataFormatted()

getParmData

public byte[] getParmData()

getRawTimeStamp

public BigInteger getRawTimeStamp()

isTimerUpperWord

public boolean isTimerUpperWord()

getNewTimerUpperWord

public long getNewTimerUpperWord()

setTracePointsUpperWord

public boolean setTracePointsUpperWord(BigInteger upperWord)

isNormalTracepoint

public boolean isNormalTracepoint()

isLostRecord

public boolean isLostRecord()

compareTo

public int compareTo(Object other)

Description copied from interface: java.lang.Comparable

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Specified by:

compareTo in interface Comparable

Parameters:

other - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

getFormattedParameters

public String getFormattedParameters()

Specified by:

getFormattedParameters in interface TracePoint

Returns:

a String containing the parameters formatted and interpolated into the TracePoint's formatting template.

getFormattedTime

public String getFormattedTime()

Specified by:

getFormattedTime in interface TracePoint

Returns:

the time in the format ????????

setIsChangeOfThread

public void setIsChangeOfThread(boolean isChangeOfThread)

isInvalid

public boolean isInvalid()

getTypeAsInt

public int getTypeAsInt()

getID

public int getID()

Specified by:

getID in interface TracePoint

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

public long getTimestampMillis()

Specified by:

getTimestampMillis in interface TracePoint

Returns:

the GMT time in milliseconds at which this TracePoint was produced.

getMicrosecondsCount

public int getMicrosecondsCount()

Specified by:

getMicrosecondsCount in interface TracePoint

Returns:

the high resolution timer value stored at the time this tracepoint was generated.

getComponent

public String getComponent()

Specified by:

getComponent in interface TracePoint

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

public String getContainerComponent()

Specified by:

getContainerComponent in interface TracePoint

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.

getParameterFormattingTemplate

public String getParameterFormattingTemplate()

Specified by:

getParameterFormattingTemplate in interface TracePoint

Returns:

a String containing the formatting template for this TracePoint.

getParameters

public Object[] getParameters()

Specified by:

getParameters in interface TracePoint

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

public String[] getGroups()

Specified by:

getGroups in interface TracePoint

Returns:

a list of groups to which this TracePoint belongs, or none if it doesn't belong to any.

getLevel

public int getLevel()

Specified by:

getLevel in interface TracePoint

Returns:

the level of this TracePoint.

getType

public String getType()

Specified by:

getType in interface TracePoint

Returns:

the type of this TracePoint, for example, Entry, Exit or Event.

from

public String from()