mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

Documentation enhancement

Browse source
This commit is contained in:
John Cortell 2009-10-01 19:44:57 +00:00
parent 17fe60355e
commit 73f0fa475b
1 changed files with 36 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/concurrent/RequestMonitor.java
View file

@ -157,21 +157,29 @@ public class RequestMonitor extends DsfExecutable {
} }
return fStatus; return fStatus;
} }
/** /**
* Sets this request monitor as canceled and calls the cancel listeners if any. * Sets this request monitor as canceled and calls the cancel listeners if
* <p> * any.
* Note: Calling cancel() does not automatically complete the RequestMonitor. * <p>
* The asynchronous call still has to call done(). * Note: Calling cancel() does not automatically complete the
* </p> * RequestMonitor. The asynchronous call still has to call done().
* <p> * </p>
* Note: logically a request should only be canceled by the client that issued * <p>
* the request in the first place. After a request is canceled, the method * Note: logically a request should only be canceled by the client that
* that is fulfilling the request may call {@link #setStatus(IStatus)} with * issued the request in the first place. After a request is canceled, the
* severity of <code>IStatus.CANCEL</code> to indicate that it recognized that * method that is fulfilling the request may call
* the given request was canceled and it did not perform the given operation. * {@link #setStatus(IStatus)} with severity of <code>IStatus.CANCEL</code>
* </p> * to indicate that it recognized that the given request was canceled and it
*/ * did not perform the given operation.
* </p>
* <p>
* Canceling a monitor effectively cancels all descendant monitors, by
* virtue of the default implementation of {@link #isCanceled()}, which
* checks not only its own state but that of its parent. However, only the
* cancel listeners of the monitor directly canceled will be called.
* </p>
*/
public void cancel() { public void cancel() {
Object[] listeners = null; Object[] listeners = null;
synchronized (this) { synchronized (this) {
@ -198,6 +206,10 @@ public class RequestMonitor extends DsfExecutable {
* canceled by the client, the implementor handling the request should * canceled by the client, the implementor handling the request should
* still call {@link #done()} in order to complete handling * still call {@link #done()} in order to complete handling
* of the request monitor. * of the request monitor.
*
* <p>
* A request monitor is considered canceled if either it or its parent was canceled.
* </p>
*/ */
public synchronized boolean isCanceled() { public synchronized boolean isCanceled() {
return fCanceled || (fParentRequestMonitor != null && fParentRequestMonitor.isCanceled()); return fCanceled || (fParentRequestMonitor != null && fParentRequestMonitor.isCanceled());
@ -205,7 +217,7 @@ public class RequestMonitor extends DsfExecutable {
/** /**
* Adds the given listener to list of listeners that are notified when this * Adds the given listener to list of listeners that are notified when this
* request monitor is canceled. * request monitor is directly canceled.
*/ */
public synchronized void addCancelListener(ICanceledListener listener) { public synchronized void addCancelListener(ICanceledListener listener) {
if (fCancelListeners == null) { if (fCancelListeners == null) {
@ -216,7 +228,7 @@ public class RequestMonitor extends DsfExecutable {
/** /**
* Removes the given listener from the list of listeners that are notified * Removes the given listener from the list of listeners that are notified
* when this request monitor is canceled. * when this request monitor is directly canceled.
*/ */
public synchronized void removeCancelListener(ICanceledListener listener) { public synchronized void removeCancelListener(ICanceledListener listener) {
if (fCancelListeners != null) { if (fCancelListeners != null) {
@ -392,14 +404,13 @@ public class RequestMonitor extends DsfExecutable {
fParentRequestMonitor.done(); fParentRequestMonitor.done();
} }
} }
/** /**
* Default handler for a canceled the completion of a request. If this * Default completion handler for a canceled request. If this monitor was
* monitor has a parent monitor that was configured by the constructor, that * constructed with a parent monitor, the status is propagated up to it.
* parent monitor is notified. Otherwise this method does nothing. * Otherwise this method does nothing. <br>
* <br> * Note: Sub-classes may override this method.
* Note: Sub-classes may override this method. */
*/
@ConfinedToDsfExecutor("fExecutor") @ConfinedToDsfExecutor("fExecutor")
protected void handleCancel() { protected void handleCancel() {
if (fParentRequestMonitor != null) { if (fParentRequestMonitor != null) {