com.deltaxml.mergecommon

Interface MergeProgressListener

All Known Implementing Classes:

MergeProgressTextReporter

public interface MergeProgressListener

Interface for listeners to monitor the progress of the merge stages.

A Merge progress listener. This is a coarse-grained progress listener that provides feedback when each stage in the merge has started and completed. It also provides feedback when a merge step (setAncestor, addVersion, extractAll) is completed. Note that some stages are significantly longer than others.

Method Summary

Modifier and Type	Method and Description
void	completed(int stagesStarted, int stagesCompleted, String stageDescription, long elapsedTime, long cpuTime) Reports when a stage has finished.
void	reportAddVersionFinish(String version, long elapsedTime, long cpuTime) Reports when the add version operation has completed.
void	reportAddVersionStart(String version) Reports when the add version operation has started.
void	reportExtractAllFinish(long elapsedTime, long cpuTime) Reports when the extract all operation has completed.
void	reportExtractAllStart() Reports when the extract all operation has started.
void	reportSetAncestorFinish(String ancestorVersion, long elapsedTime, long cpuTime) Reports when the set ancestor operation has completed.
void	reportSetAncestorStart(String ancestorVersion) Reports when the set ancestor operation has started.
void	stages(int enabledStages) Report the number of enabled stages.
void	started(int stagesStarted, int stagesCompleted, String stageDescription) Reports when a stage has started.

Method Detail

stages

void stages(int enabledStages)

Report the number of enabled stages.

Parameters:

enabledStages - The number of enabled stages.

started

void started(int stagesStarted,
             int stagesCompleted,
             String stageDescription)

Reports when a stage has started.

Parameters:

stagesStarted - Number of stages started

stagesCompleted - Number of stages finished

stageDescription - Description of the stage started

completed

void completed(int stagesStarted,
               int stagesCompleted,
               String stageDescription,
               long elapsedTime,
               long cpuTime)

Reports when a stage has finished.

Parameters:

stagesStarted - Number of stages started

stagesCompleted - Number of stages completed

stageDescription - Description of the stage finished

elapsedTime - The elapsed time taken to execute this stage (in nanoseconds).

cpuTime - The CPU time taken to execute this stage (in nanoseconds).

reportSetAncestorStart

void reportSetAncestorStart(String ancestorVersion)

Reports when the set ancestor operation has started. Please note that this event will only be reported by the concurrent merge.

Parameters:

ancestorVersion - The name of the ancestor version.

reportSetAncestorFinish

void reportSetAncestorFinish(String ancestorVersion,
                             long elapsedTime,
                             long cpuTime)

Reports when the set ancestor operation has completed. Please note that this event will only be reported by the concurrent merge.

Parameters:

ancestorVersion - The name of the ancestor version.

elapsedTime - The elapsed time taken to execute the set ancestor stage (in nanoseconds).

cpuTime - The CPU time taken to execute the set ancestor stage (in nanoseconds).

reportAddVersionStart

void reportAddVersionStart(String version)

Reports when the add version operation has started.

Parameters:

version - The name of the version.

reportAddVersionFinish

void reportAddVersionFinish(String version,
                            long elapsedTime,
                            long cpuTime)

Reports when the add version operation has completed.

Parameters:

version - The name of the version.

elapsedTime - The elapsed time taken to execute this add version stage (in nanoseconds).

cpuTime - The CPU time taken to execute this add version stage (in nanoseconds).

reportExtractAllStart

void reportExtractAllStart()

Reports when the extract all operation has started.

reportExtractAllFinish

void reportExtractAllFinish(long elapsedTime,
                            long cpuTime)

Reports when the extract all operation has completed.

Parameters:

elapsedTime - The elapsed time taken to execute the extract all stage (in nanoseconds).

cpuTime - The CPU time taken to execute the extract all stage (in nanoseconds).