Module com.microsoft.gctoolkit.api

Package com.microsoft.gctoolkit.io

Class SingleGCLogFile

java.lang.Object

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

com.microsoft.gctoolkit.io.GCLogFile

com.microsoft.gctoolkit.io.SingleGCLogFile

All Implemented Interfaces:

DataSource<String>

public class SingleGCLogFile
extends GCLogFile

A single GC log file. If the file is a zip or gzip file, then the first entry is the file of interest.

Field Summary

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

END_OF_DATA_SENTINEL

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

path

Constructor Summary

Constructors

Constructor	Description
SingleGCLogFile(Path path)

Method Summary

Modifier and Type	Method	Description
LogFileMetadata	getMetaData()	Return meta data about the file.
Stream<String>	stream()	Return a stream of the data.

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

diary, endOfData, getJavaVirtualMachine, isUnified

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

getPath, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleGCLogFile

public SingleGCLogFile(Path path)

Method Detail

getMetaData

public LogFileMetadata getMetaData()
                            throws IOException

Description copied from class: FileDataSource

Return meta data about the file.

Specified by:

getMetaData in class FileDataSource<String>

Returns:

Meta data about the file.

Throws:

IOException - when there is an issue generating the diary

stream

public Stream<String> stream()
                      throws IOException

Description copied from interface: DataSource

Return a stream of the data.

Returns:

A stream of the data.

Throws:

IOException - Thrown if the data cannot be streamed, or an IOException is raised while streaming.