|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IStatus
A status object represents the outcome of an operation.
All CoreExceptions carry a status object to indicate
what went wrong. Status objects are also returned by methods needing
to provide details of failures (e.g., validation methods).
A status carries the following information:
The class Status is the standard public implementation
of status objects; the subclass MultiStatus is the
implements multi-status objects.
This interface can be used without OSGi running.
MultiStatus,
Status| Field Summary | |
|---|---|
static int |
CANCEL
Status type severity (bit mask, value 8) indicating this status represents a cancelation |
static int |
ERROR
Status type severity (bit mask, value 4) indicating this status represents an error. |
static int |
INFO
Status type severity (bit mask, value 1) indicating this status is informational only. |
static int |
OK
Status severity constant (value 0) indicating this status represents the nominal case. |
static int |
WARNING
Status type severity (bit mask, value 2) indicating this status represents a warning. |
| Method Summary | |
|---|---|
IStatus[] |
getChildren()
Returns a list of status object immediately contained in this multi-status, or an empty list if this is not a multi-status. |
int |
getCode()
Returns the plug-in-specific status code describing the outcome. |
Throwable |
getException()
Returns the relevant low-level exception, or null if none. |
String |
getMessage()
Returns the message describing the outcome. |
String |
getPlugin()
Returns the unique identifier of the plug-in associated with this status (this is the plug-in that defines the meaning of the status code). |
int |
getSeverity()
Returns the severity. |
boolean |
isMultiStatus()
Returns whether this status is a multi-status. |
boolean |
isOK()
Returns whether this status indicates everything is okay (neither info, warning, nor error). |
boolean |
matches(int severityMask)
Returns whether the severity of this status matches the given severity mask. |
| Field Detail |
|---|
static final int OK
getSeverity(),
isOK(),
Constant Field Valuesstatic final int INFO
getSeverity(),
matches(int),
Constant Field Valuesstatic final int WARNING
getSeverity(),
matches(int),
Constant Field Valuesstatic final int ERROR
getSeverity(),
matches(int),
Constant Field Valuesstatic final int CANCEL
getSeverity(),
matches(int),
Constant Field Values| Method Detail |
|---|
IStatus[] getChildren()
isMultiStatus()int getCode()
Throwable getException()
null if none.
For example, when an operation fails because of a network communications
failure, this might return the java.io.IOException
describing the exact nature of that failure.
null if noneString getMessage()
String getPlugin()
int getSeverity()
CANCEL - cancelation occurredERROR - a serious error (most severe)WARNING - a warning (less severe)INFO - an informational ("fyi") message (least severe)OK - everything is just fine
The severity of a multi-status is defined to be the maximum
severity of any of its children, or OK if it has
no children.
OK, ERROR,
INFO, WARNING, or CANCELmatches(int)boolean isMultiStatus()
The severity of a multi-status is derived from the severities
of its children; a multi-status with no children is
OK by definition.
A multi-status carries a plug-in identifier, a status code,
a message, and an optional exception. Clients may treat
multi-status objects in a multi-status unaware way.
true for a multi-status,
false otherwisegetChildren()boolean isOK()
true if this status has severity
OK, and false otherwiseboolean matches(int severityMask)
OK
will never match; use isOK instead to detect
a status with a severity of OK.
severityMask - a mask formed by bitwise or'ing severity mask
constants (ERROR, WARNING,
INFO, CANCEL)
true if there is at least one match,
false if there are no matchesgetSeverity(),
CANCEL,
ERROR,
WARNING,
INFO
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.