Module openj9.traceformat

Package com.ibm.jvm.trace.format.api

Class TraceRecord

java.lang.Object

com.ibm.jvm.trace.format.api.TraceRecord

All Implemented Interfaces:

Comparable<TraceRecord>

public class TraceRecord
extends Object
implements Comparable<TraceRecord>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TRACERECORD_HEADER_SIZE

Constructor Summary

Constructors

Constructor	Description
TraceRecord(TraceContext context, byte[] data)	This will create a TraceRecord from a byte array.
TraceRecord(TraceContext context, RandomAccessFile file, long offset)

Method Summary

Modifier and Type	Method	Description
int	appendToStream(ByteStream stream, boolean newThread)	Appends the body of the data from this trace record to the stream IN CHRONOLOGICAL ORDER.
int	compareTo(TraceRecord other)	Compares this object with the specified object for order.
String	summary()

Methods declared in class java.lang.Object

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

Field Details

TRACERECORD_HEADER_SIZE

public static final int TRACERECORD_HEADER_SIZE

See Also:

• Constant Field Values

Constructor Details

TraceRecord

public TraceRecord(TraceContext context,
 byte[] data)
            throws IllegalArgumentException

This will create a TraceRecord from a byte array. The byte array must be of the correct length for a trace record in this context.

Parameters:

context -

data -

Throws:

IllegalArgumentException

TraceRecord

public TraceRecord(TraceContext context,
 RandomAccessFile file,
 long offset)
            throws IOException,
IllegalArgumentException

Throws:

IOException

IllegalArgumentException

Method Details

appendToStream

public int appendToStream(ByteStream stream,
 boolean newThread)

Appends the body of the data from this trace record to the stream IN CHRONOLOGICAL ORDER. This means that if the buffer wrapped at all the data will be reordered so that reading from the bytestream will return data correctly ordered for reading as a continuous temporal stream.

Parameters:

stream - - the stream onto which the record should be appended

newThread - - indicates whether this is the first record on a thread

Returns:

the number of bytes appended

summary

public String summary()

compareTo

public int compareTo(TraceRecord 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<TraceRecord>

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.