Module com.microsoft.gctoolkit.api

Package com.microsoft.gctoolkit.io

Interface DataSource<T>

Type Parameters:

T - The type of data returned in the stream.

All Known Implementing Classes:

FileDataSource, GCLogFile, RotatingGCLogFile, SingleGCLogFile

public interface DataSource<T>

A source of data which may be streamed.

Method Summary

Modifier and Type	Method	Description
Diary	diary()	Return meta data for the data source
T	endOfData()	Return a sentinel value marking the end of the data.
Stream<T>	stream()	Return a stream of the data.

Method Detail

diary

Diary diary()
     throws IOException

Return meta data for the data source

Returns:

diary contains log file metadata

Throws:

IOException - if there is an issue generating the diary

stream

Stream<T> stream()
          throws IOException

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.

endOfData

T endOfData()

Return a sentinel value marking the end of the data.

Returns:

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