Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.progress/1 1.5.22
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.netbeans.api.progress.aggregate
Class ProgressContributor

    java.lang.Object
      org.netbeans.api.progress.aggregate.ProgressContributor

    public final class ProgressContributor

extends Object

A contributor to the aggragete progress indication. This class is not threadsafe, you should access the contributor from one thread only.

See Also:
  `AggregateProgressHandle.addContributor(ProgressContributor)`

Method Summary
`void` | `finish()` finish the contributor, possibly also the whole task if this instance was the last one to finish.
`String` | `getTrackingId()` an id that allows identification of the progress contributor by the monitor.
`void` | `progress(int workunit)` Notify the user about completed workunits.
`void` | `progress(String message)` Notify the user about progress by showing message with details.
`void` | `progress(String message, int unit)` Notify the user about completed workunits.
`void` | `start(int workunits)` start the progress indication for a task with known number of steps.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getTrackingId

    public String getTrackingId()

  an id that allows identification of the progress contributor by the monitor.

### start

    public void start(int workunits)

  start the progress indication for a task with known number of steps.

  Parameters:
    `workunits` - a total number of workunits that this contributor will process.

### finish

    public void finish()

  finish the contributor, possibly also the whole task if this instance was the last one to finish.

### progress

    public void progress(int workunit)

  Notify the user about completed workunits.

  Parameters:
    `workunit` - a cumulative number of workunits completed so far

### progress

    public void progress(String message)

  Notify the user about progress by showing message with details.

  Parameters:
    `message` - detailed info about current progress

### progress

    public void progress(String message,
                         int unit)

  Notify the user about completed workunits.

  Parameters:
    `message` - detailed info about current progress
    `unit` - a cumulative number of workunits completed so far

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.progress/1 1.5.22
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Built on December 7 2006. | Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.