diff options
Diffstat (limited to 'org.eclipse.debug.core/core/org/eclipse/debug/core/IRequest.java')
| -rw-r--r-- | org.eclipse.debug.core/core/org/eclipse/debug/core/IRequest.java | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IRequest.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IRequest.java index 827697b32..d220503fc 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IRequest.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IRequest.java @@ -37,51 +37,51 @@ import org.eclipse.core.runtime.IStatus; */ public interface IRequest { - /** - * Sets the status for this request indicating whether this request - * succeeded, failed, or was canceled. When a request fails, the status - * indicates why the request failed. A <code>null</code> status is considered - * to be successful. Only clients fulfilling a request should call this - * method. Clients making a request are not intended to call this method. - * - * @param status request status or <code>null</code> - */ - void setStatus(IStatus status); + /** + * Sets the status for this request indicating whether this request + * succeeded, failed, or was canceled. When a request fails, the status + * indicates why the request failed. A <code>null</code> status is considered + * to be successful. Only clients fulfilling a request should call this + * method. Clients making a request are not intended to call this method. + * + * @param status request status or <code>null</code> + */ + void setStatus(IStatus status); - /** - * Returns the status of this request, or <code>null</code>. - * - * @return request status - <code>null</code> is equivalent - * to an OK status - */ - IStatus getStatus(); + /** + * Returns the status of this request, or <code>null</code>. + * + * @return request status - <code>null</code> is equivalent + * to an OK status + */ + IStatus getStatus(); - /** - * Indicates this request is complete. Clients must call this method - * whether the request succeeds, fails, or is cancelled to indicate that - * processing is complete. Only clients fulfilling a request should call this - * method. Clients making a request are not intended to call this method. - */ - void done(); + /** + * Indicates this request is complete. Clients must call this method + * whether the request succeeds, fails, or is cancelled to indicate that + * processing is complete. Only clients fulfilling a request should call this + * method. Clients making a request are not intended to call this method. + */ + void done(); - /** - * Cancels this request. A request may be canceled by the originator of request - * or a client fulfilling a request. Optionally a canceled status may be set on - * this request with more details. A client fulfilling a request must still call - * <code>done()</code> to indicate the request is complete. - */ - void cancel(); + /** + * Cancels this request. A request may be canceled by the originator of request + * or a client fulfilling a request. Optionally a canceled status may be set on + * this request with more details. A client fulfilling a request must still call + * <code>done()</code> to indicate the request is complete. + */ + void cancel(); - /** - * Returns whether this request has been canceled. - * <p> - * Clients fulfilling a request are expected to poll a request (using <code>isCanceled</code>) - * periodically and abort at their earliest convenience calling <code>done()</code>. - * A request can be canceled by the originator of the request or a processor fulfilling a - * request. - * </p> - * @return whether this request has been canceled - */ - boolean isCanceled(); + /** + * Returns whether this request has been canceled. + * <p> + * Clients fulfilling a request are expected to poll a request (using <code>isCanceled</code>) + * periodically and abort at their earliest convenience calling <code>done()</code>. + * A request can be canceled by the originator of the request or a processor fulfilling a + * request. + * </p> + * @return whether this request has been canceled + */ + boolean isCanceled(); } |