Overview | Package | Class | Use | Tree | Deprecated | Index | Help

Neo4j Community
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.neo4j.helpers
Class ProgressIndicator.SimpleProgress

    java.lang.Object
      org.neo4j.helpers.ProgressIndicator.SimpleProgress

All Implemented Interfaces:
  ProgressIndicator

Direct Known Subclasses:
  ProgressIndicator.MultiProgress

Enclosing interface:
  ProgressIndicator

    public abstract static class ProgressIndicator.SimpleProgress

extends Object
implements ProgressIndicator

A `ProgressIndicator` that can report the progress for a single source. Should be initialized with the total count that the source is going to reach.

Author:
  Tobias Lindaaker

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.helpers.ProgressIndicator
`ProgressIndicator.MultiProgress, ProgressIndicator.SimpleProgress, ProgressIndicator.UnknownEndProgress`

Constructor Summary
`ProgressIndicator.SimpleProgress(long total)` Create a `ProgressIndicator` for a single source.

Method Summary
`void` | `done(long totalProgress)` Mark the process as done with the current source.
`protected abstract void` | `progress(int permille)` Implement this method to emit the progress notifications.
`static ProgressIndicator.SimpleProgress` | `textual(PrintStream out, long total)` Returns a simple `ProgressIndicator` that reports progress by printing to the provided stream.
`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.SimpleProgress

    public ProgressIndicator.SimpleProgress(long total)

  Create a `ProgressIndicator` for a single source.

  Parameters:
    `total` - the total count the process will reach.

Method Detail

### textual

    public static ProgressIndicator.SimpleProgress textual(PrintStream out,
                                                           long total)

  Returns a simple `ProgressIndicator` that reports progress by printing to the provided stream.

  Parameters:
    `out` - the stream to print progress indication to.
    `total` - the total count the process will reach.
  Returns:
    a simple `ProgressIndicator` that reports progress by printing to the provided stream.

### 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.

### progress

    protected abstract void progress(int permille)

  Implement this method to emit the progress notifications.

  Parameters:
    `permille` - value from 0 (just started) to 1000 (done) indicating how far along the process is.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

Neo4j Community
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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