Examples of IProgressMonitor

org.eclipse.core.runtime.IProgressMonitor

The IProgressMonitor interface is implemented by objects that monitor the progress of an activity; the methods in this interface are invoked by code that performs the activity.

All activity is broken down into a linear sequence of tasks against which progress is reported. When a task begins, a beginTask(String, int) notification is reported, followed by any number and mixture of progress reports (worked()) and subtask notifications (subTask(String)). When the task is eventually completed, a done() notification is reported. After the done() notification, the progress monitor cannot be reused; i.e., beginTask(String, int) cannot be called again after the call to done().

A request to cancel an operation can be signaled using the setCanceled method. Operations taking a progress monitor are expected to poll the monitor (using isCanceled) periodically and abort at their earliest convenience. Operation can however choose to ignore cancelation requests.

Since notification is synchronous with the activity itself, the listener should provide a fast and robust implementation. If the handling of notifications would involve blocking operations, or operations which might throw uncaught exceptions, the notifications should be queued, and the actual processing deferred (or perhaps delegated to a separate thread).

This interface can be used without OSGi running.

Clients may implement this interface.

  public void run(IProgressMonitor monitor) throws Exception {


    if (monitor == null) {
      monitor = new NullProgressMonitor();
    }
    IProgressMonitor prepMonitor = SubMonitor.convert(monitor, 80);
    prepMonitor.beginTask("Splitting features", 1); //$NON-NLS-1$


    LineString splitter = getSplittingLineInMapCRS(handler);
    assert splitter.getUserData() instanceof CoordinateReferenceSystem;


    FeatureCollection<SimpleFeatureType, SimpleFeature> featuresToSplit = getFeaturesToSplit(splitter);
    prepMonitor.worked(2);


    final List<UndoableMapCommand> undoableCommands = new ArrayList<UndoableMapCommand>();


    List<UndoableMapCommand> commands = buildCommandList(featuresToSplit, splitter);
    undoableCommands.addAll(commands);
    prepMonitor.worked(3);


    prepMonitor.done();


    if (undoableCommands.size() == 0) {
            ProjectPlugin.log("The split did not apply to any feature"); //$NON-NLS-1$
        
      throw new IllegalArgumentException(Messages.SplitFeaturesCommand_did_not_apply_to_any_feature);
    }
    IProgressMonitor splitMonitor = SubMonitor.convert(monitor, 20);
    composite = new UndoableComposite(undoableCommands);


    // cascade setMap on the aggregate commands
    composite.setMap(getMap());
    composite.run(splitMonitor);

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of IProgressMonitor

Examples of org.eclipse.core.runtime.IProgressMonitor