Package org.variantsync.diffdetective.analysis

Class StatisticsAnalysis

java.lang.Object

org.variantsync.diffdetective.analysis.StatisticsAnalysis

All Implemented Interfaces:

Analysis.Hooks

public class StatisticsAnalysis
extends Object
implements Analysis.Hooks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StatisticsAnalysis.Result	Invariant: StatisticsAnalysis.Result.emptyCommits + StatisticsAnalysis.Result.failedCommits + StatisticsAnalysis.Result.processedCommits + filteredCommits = totalCommits

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMIT_TIME_FILE_EXTENSION
private final Clock	commitProcessTimer
private final List<CommitProcessTime>	commitTimes
private int	numVariationDiffs
static final AnalysisResult.ResultKey<StatisticsAnalysis.Result>	RESULT
private final Clock	totalTime

Constructor Summary

Constructors

Constructor	Description
StatisticsAnalysis()

Method Summary

Modifier and Type	Method	Description
boolean	analyzeVariationDiff(Analysis analysis)	The main hook for analyzing non-empty diff trees.
void	beginBatch(Analysis analysis)
boolean	beginCommit(Analysis analysis)
void	endBatch(Analysis analysis)
void	endCommit(Analysis analysis)
static void	exportCommitTimes(List<CommitProcessTime> commitTimes, Path pathToOutputFile)	Exports the given commit times to the given file.
void	initializeResults(Analysis analysis)	Initialization hook for Analysis.getResult().
void	onFailedCommit(Analysis analysis)	Signals a parsing failure of all patches in the current commit.
boolean	onParsedCommit(Analysis analysis)	Signals the completion of the commit diff extraction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.variantsync.diffdetective.analysis.Analysis.Hooks

beginPatch, endPatch, onFailedParse

Field Details

COMMIT_TIME_FILE_EXTENSION

public static final String COMMIT_TIME_FILE_EXTENSION

See Also:

• Constant Field Values

RESULT

public static final AnalysisResult.ResultKey<StatisticsAnalysis.Result> RESULT

commitTimes

private final List<CommitProcessTime> commitTimes

totalTime

private final Clock totalTime

commitProcessTimer

private final Clock commitProcessTimer

numVariationDiffs

private int numVariationDiffs

Constructor Details

StatisticsAnalysis

public StatisticsAnalysis()

Method Details

initializeResults

public void initializeResults(Analysis analysis)

Description copied from interface: Analysis.Hooks

Initialization hook for Analysis.getResult(). All result types should be appended with a neutral value using Analysis.append(org.variantsync.diffdetective.analysis.AnalysisResult.ResultKey<T>, T). No other side effects should be performed during this methods as it might be called an arbitrary amount of times.

Specified by:

initializeResults in interface Analysis.Hooks

beginBatch

public void beginBatch(Analysis analysis)

Specified by:

beginBatch in interface Analysis.Hooks

beginCommit

public boolean beginCommit(Analysis analysis)

Specified by:

beginCommit in interface Analysis.Hooks

onParsedCommit

public boolean onParsedCommit(Analysis analysis)

Description copied from interface: Analysis.Hooks

Signals the completion of the commit diff extraction. Called exactly once during the commit phase before the patch phase begins.

Specified by:

onParsedCommit in interface Analysis.Hooks

onFailedCommit

public void onFailedCommit(Analysis analysis)

Description copied from interface: Analysis.Hooks

Signals a parsing failure of all patches in the current commit. Called at most once during the commit phase. If this hook is called Analysis.Hooks.onParsedCommit(org.variantsync.diffdetective.analysis.Analysis) and the following patch phase invocations are skipped.

Specified by:

onFailedCommit in interface Analysis.Hooks

analyzeVariationDiff

public boolean analyzeVariationDiff(Analysis analysis)

Description copied from interface: Analysis.Hooks

The main hook for analyzing non-empty diff trees. Called at most once during the patch phase.

Specified by:

analyzeVariationDiff in interface Analysis.Hooks

endCommit

public void endCommit(Analysis analysis)

Specified by:

endCommit in interface Analysis.Hooks

endBatch

public void endBatch(Analysis analysis)
              throws IOException

Specified by:

endBatch in interface Analysis.Hooks

Throws:

IOException

exportCommitTimes

public static void exportCommitTimes(List<CommitProcessTime> commitTimes,
 Path pathToOutputFile)
                              throws IOException

Exports the given commit times to the given file. Overwrites existing files.

Parameters:

commitTimes - List of all CommitProcessTimes to write into a single file.

pathToOutputFile - Output file to write.

Throws:

IOException