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
Interface ProgressIndicator

All Known Implementing Classes:
  ProgressIndicator.MultiProgress, ProgressIndicator.SimpleProgress, ProgressIndicator.UnknownEndProgress

Deprecated. use `ProgressIndicator.SimpleProgress` instead.

    @Deprecated
    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` Deprecated. A `ProgressIndicator` that can report the total progress for multiple sources.
`static class` | `ProgressIndicator.SimpleProgress` Deprecated. A `ProgressIndicator` that can report the progress for a single source.
`static class` | `ProgressIndicator.UnknownEndProgress` Deprecated. Progress indicator where the end is unknown.

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

Method Detail

### update

    void update(boolean incremental,
                long value)

  Deprecated.
  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)

  Deprecated.
  Mark the process as done with the current source.

  Parameters:
    `totalProgress` - the total progress reached by the source.

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.