Neo4j Enterprise

org.neo4j.helpers
Class ProgressIndicator.UnknownEndProgress

java.lang.Object
  extended by org.neo4j.helpers.ProgressIndicator.UnknownEndProgress
All Implemented Interfaces:
ProgressIndicator
Enclosing interface:
ProgressIndicator

public static class ProgressIndicator.UnknownEndProgress
extends Object
implements ProgressIndicator

Progress indicator where the end is unknown. Specify a step size which means that a means of progress will be printed every step.

Author:
Mattias Persson

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.neo4j.helpers.ProgressIndicator
ProgressIndicator.Decorator, ProgressIndicator.Factory, ProgressIndicator.MultiProgress, ProgressIndicator.SimpleProgress, ProgressIndicator.Textual, ProgressIndicator.UnknownEndProgress
 
Field Summary
 
Fields inherited from interface org.neo4j.helpers.ProgressIndicator
NONE
 
Constructor Summary
ProgressIndicator.UnknownEndProgress(long stepSize, String doneMessage)
           
ProgressIndicator.UnknownEndProgress(long stepSize, String doneMessage, PrintStream out)
           
 
Method Summary
 void done()
          Signal that the entire progress has completed.
 void done(long totalProgress)
          Mark the process as done with the current source.
 void phase(String phase)
          Set the name of the current phase of the progress.
 void update(boolean incremental, long value)
          Update the current progress count for the current source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressIndicator.UnknownEndProgress

public ProgressIndicator.UnknownEndProgress(long stepSize,
                                            String doneMessage)

ProgressIndicator.UnknownEndProgress

public ProgressIndicator.UnknownEndProgress(long stepSize,
                                            String doneMessage,
                                            PrintStream out)
Method Detail

phase

public void phase(String phase)
Description copied from interface: ProgressIndicator
Set the name of the current phase of the progress. This is an optional method that users of progress indication can use to notify the progress indicator of the name of the current phase, if the progress indicator supports it. A progress indicator can choose not to support this feature by implementing this method as a no-op. A progress indicator must support clients that don't invoke this method.

Specified by:
phase in interface ProgressIndicator
Parameters:
phase - the name of the current phase.

update

public void update(boolean incremental,
                   long value)
Description copied from interface: ProgressIndicator
Update the current progress count for the current source.

Specified by:
update in interface ProgressIndicator
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

public void done(long totalProgress)
Description copied from interface: ProgressIndicator
Mark the process as done with the current source.

Specified by:
done in interface ProgressIndicator
Parameters:
totalProgress - the total progress reached by the source.

done

public void done()
Description copied from interface: ProgressIndicator
Signal that the entire progress has completed. This method is generally only used by processes that process multiple phases, where the ProgressIndicator.done(long) method is used to indicate the completion of a single phase, rather than the completion of the entire process. To not invoke this method from a process that only processes a single phase is perfectly acceptable.

Specified by:
done in interface ProgressIndicator

Neo4j Enterprise

Copyright © 2002-2012 The Neo4j Graph Database Project. All Rights Reserved.