org.neo4j.helpers
Interface ProgressIndicator

All Known Implementing Classes:

ProgressIndicator.MultiProgress, ProgressIndicator.SimpleProgress, ProgressIndicator.UnknownEndProgress

public interface ProgressIndicator

A generic interface for reporting progress by a tool. Can be implemented to support reporting progress from both a single source, or for the aggregate of multiple sources.

Author:

Tobias Lindaaker

Nested Class Summary

static class	ProgressIndicator.MultiProgress A ProgressIndicator that can report the total progress for multiple sources.
static class	ProgressIndicator.SimpleProgress A ProgressIndicator that can report the progress for a single source.
static class	ProgressIndicator.UnknownEndProgress Progress indicator where the end is unknown.

Method Summary

void	done(long totalProgress) Mark the process as done with the current source.
void	update(boolean incremental, long value) Update the current progress count for the current source.

Method Detail

update

void update(boolean incremental,
            long value)

Update the current progress count for the current source.

Parameters:

incremental - whether this is an incremental update ( true) or an absolute assignment ( false) of the progress.

value - the count to update the progress with.

done

void done(long totalProgress)

Mark the process as done with the current source.

Parameters:

totalProgress - the total progress reached by the source.