Examples of org.eclipse.core.runtime.SubMonitor.newChild()

• org.eclipse.core.runtime.SubMonitor.newChild()
  // Example 1: Typical usage of newChild void myMethod(IProgressMonitor parent) { SubMonitor progress = SubMonitor.convert(parent, 100); doSomething(progress.newChild(50)); doSomethingElse(progress.newChild(50)); } //////////////////////////////////////////////////////////////////////////// // Example 2: Demonstrates the function of active children. Creating children // is sufficient to smoothly report progress, even if worked(...) and done() // are never called. void myMethod(IProgressMonitor parent) { SubMonitor progress = SubMonitor.convert(parent, 100); for (int i = 0; i < 100; i++) { // Creating the next child monitor will clean up the previous one, // causing progress to be reported smoothly even if we don't do anything // with the monitors we create progress.newChild(1); } } //////////////////////////////////////////////////////////////////////////// // Example 3: Demonstrates a common anti-pattern void wrongMethod(IProgressMonitor parent) { SubMonitor progress = SubMonitor.convert(parent, 100); // WRONG WAY: Won't have the intended effect, as only one of these progress // monitors may be active at a time and the other will report no progress. callMethod(progress.newChild(50), computeValue(progress.newChild(50))); } void rightMethod(IProgressMonitor parent) { SubMonitor progress = SubMonitor.convert(parent, 100); // RIGHT WAY: Break up method calls so that only one SubMonitor is in use at a time. Object someValue = computeValue(progress.newChild(50)); callMethod(progress.newChild(50), someValue); } @param totalWork number of ticks to consume from the receiver @return new sub progress monitor that may be used in place of a new SubMonitor