Module com.microsoft.gctoolkit.api

Package com.microsoft.gctoolkit.io

Class GCLogFile

java.lang.Object

com.microsoft.gctoolkit.io.FileDataSource<String>

com.microsoft.gctoolkit.io.GCLogFile

All Implemented Interfaces:

DataSource<String>

Direct Known Subclasses:

RotatingGCLogFile, SingleGCLogFile

public abstract class GCLogFile
extends FileDataSource<String>

Represents a GC log file, which may be a SingleGCLogFile or a RotatingGCLogFile.

Field Summary

Fields

Modifier and Type	Field	Description
static String	END_OF_DATA_SENTINEL	The value used for the implementation of endOfData().

Fields inherited from class com.microsoft.gctoolkit.io.FileDataSource

path

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GCLogFile(Path path)	Subclass only.

Method Summary

Modifier and Type	Method	Description
Diary	diary()	The Diary contains a summary of important properties of the log that will be used in orchestrating the setup and configuration of the internal components of GCToolkit.
String	endOfData()	Return a sentinel value marking the end of the data.
JavaVirtualMachine	getJavaVirtualMachine()	Return the relevant JavaVirtualMachine implementation
boolean	isUnified()	Returns true if this GCLogFile is written in unified logging (JEP 158) format.

Methods inherited from class com.microsoft.gctoolkit.io.FileDataSource

getMetaData, getPath, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.gctoolkit.io.DataSource

stream

Field Detail

END_OF_DATA_SENTINEL

public static final String END_OF_DATA_SENTINEL

The value used for the implementation of endOfData().

See Also:

Constant Field Values

Constructor Detail

GCLogFile

protected GCLogFile(Path path)

Subclass only.

Parameters:

path - The path to the GCLogFile or, in the case of rotating log files, the parent directory.

Method Detail

getJavaVirtualMachine

public JavaVirtualMachine getJavaVirtualMachine()

Return the relevant JavaVirtualMachine implementation

isUnified

public boolean isUnified()

Returns true if this GCLogFile is written in unified logging (JEP 158) format.

Returns:

true if the log file is in unified logging format.

diary

public Diary diary()
            throws IOException

Description copied from class: FileDataSource

The Diary contains a summary of important properties of the log that will be used in orchestrating the setup and configuration of the internal components of GCToolkit.

Specified by:

diary in interface DataSource<String>

Specified by:

diary in class FileDataSource<String>

Returns:

the computed diary

Throws:

IOException - if there is an issue generating the diary

endOfData

public final String endOfData()

Description copied from interface: DataSource

Return a sentinel value marking the end of the data.

Returns:

A value used as a sentinel to mark the end of data.