Module openj9.traceformat

Package com.ibm.jvm.format

Class TraceFileHeader

java.lang.Object

com.ibm.jvm.format.TraceFileHeader

All Implemented Interfaces:

TraceFileHeader

public final class TraceFileHeader
extends Object
implements TraceFileHeader

Encapsulates the header for a trace file.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	EXTERNAL
protected static final int	INTERNAL
protected TraceSection	traceSection

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TraceFileHeader(TraceFile traceFile)

Method Summary

Modifier and Type	Method	Description
protected final String	formatFileName()
protected final int	getBufferSize()	returns the size of the buffers in the associated trace file
long	getFirstTracePointMillis()
long	getJVMStartedMillis()
long	getLastBufferWriteMillis()
long	getLastTracePointMillis()
protected final long	getLength()	returns the length of this file header
protected final String	getNextFormatFileName(String previous)
String[]	getSysProcessorInfo()
final long	getTraceDataStart()
String[]	getTraceParameters()
protected final String	getVMLevel()
String[]	getVMStartUpParameters()
String	getVMVersion()
protected static final boolean	isUTE()	returns true if a UTE trace file is being processed
protected final void	processTraceBufferHeaders()
protected final void	summarize(BufferedWriter out)

Methods declared in class java.lang.Object

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

Field Details

traceSection

protected TraceSection traceSection

INTERNAL

protected static final int INTERNAL

See Also:

• Constant Field Values

EXTERNAL

protected static final int EXTERNAL

See Also:

• Constant Field Values

Constructor Details

TraceFileHeader

protected TraceFileHeader(TraceFile traceFile)
                   throws IOException

Throws:

IOException

Method Details

processTraceBufferHeaders

protected final void processTraceBufferHeaders()
                                        throws IOException

Throws:

IOException

summarize

protected final void summarize(BufferedWriter out)
                        throws IOException

Throws:

IOException

getLength

protected final long getLength()

returns the length of this file header

Returns:

a long

getBufferSize

protected final int getBufferSize()

returns the size of the buffers in the associated trace file

Returns:

an int

formatFileName

protected final String formatFileName()

getVMLevel

protected final String getVMLevel()

getNextFormatFileName

protected final String getNextFormatFileName(String previous)

isUTE

protected static final boolean isUTE()

returns true if a UTE trace file is being processed

Returns:

a boolean

getTraceDataStart

public final long getTraceDataStart()

getVMVersion

public String getVMVersion()

Specified by:

getVMVersion in interface TraceFileHeader

Returns:

a String representation of the JVM that produced the current TraceFile, null if no valid data.

getVMStartUpParameters

public String[] getVMStartUpParameters()

Specified by:

getVMStartUpParameters in interface TraceFileHeader

Returns:

a String array representation of the startup parameters that were used to start the JVM that produced the current TraceFile, null if no valid data.

getTraceParameters

public String[] getTraceParameters()

Specified by:

getTraceParameters in interface TraceFileHeader

Returns:

a String array representation of the Trace startup parameters that were used to start the JVM that produced the current TraceFile, null if no valid data.

getSysProcessorInfo

public String[] getSysProcessorInfo()

Specified by:

getSysProcessorInfo in interface TraceFileHeader

Returns:

a String array representation of the system on which the JVM that produced the current TraceFile was run, null if no valid data.

getJVMStartedMillis

public long getJVMStartedMillis()

Specified by:

getJVMStartedMillis in interface TraceFileHeader

Returns:

the millisecond time at which the JVM that produced the current TraceFile was started. Returns -1 if no valid data.

getLastBufferWriteMillis

public long getLastBufferWriteMillis()

Specified by:

getLastBufferWriteMillis in interface TraceFileHeader

Returns:

the millisecond time at which the JVM that produced the current TraceFile wrote its most recent TracePoint before the production of the current TraceFile. Returns -1 if no valid data.

getFirstTracePointMillis

public long getFirstTracePointMillis()

Specified by:

getFirstTracePointMillis in interface TraceFileHeader

Returns:

the millisecond time of the first TracePoint in the current TraceFile. This may not be the first TracePoint that the JVM produced. Returns -1 if no valid data.

getLastTracePointMillis

public long getLastTracePointMillis()

Specified by:

getLastTracePointMillis in interface TraceFileHeader

Returns:

the millisecond time of the last TracePoint in the current TraceFile. This may not be the last TracePoint that the JVM produced. Returns -1 if no valid data.