|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.runtime.Status
org.eclipse.core.runtime.MultiStatus
public class MultiStatus
A concrete multi-status implementation, suitable either for instantiating or subclassing.
This class can be used without OSGi running.
| Field Summary |
|---|
| Fields inherited from class org.eclipse.core.runtime.Status |
|---|
CANCEL_STATUS, OK_STATUS |
| Fields inherited from interface org.eclipse.core.runtime.IStatus |
|---|
CANCEL, ERROR, INFO, OK, WARNING |
| Constructor Summary | |
|---|---|
MultiStatus(String pluginId,
int code,
IStatus[] newChildren,
String message,
Throwable exception)
Creates and returns a new multi-status object with the given children. |
|
MultiStatus(String pluginId,
int code,
String message,
Throwable exception)
Creates and returns a new multi-status object with no children. |
|
| Method Summary | |
|---|---|
void |
add(IStatus status)
Adds the given status to this multi-status. |
void |
addAll(IStatus status)
Adds all of the children of the given status to this multi-status. |
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. |
boolean |
isMultiStatus()
Returns whether this status is a multi-status. |
void |
merge(IStatus status)
Merges the given status into this multi-status. |
String |
toString()
Returns a string representation of the status, suitable for debugging purposes only. |
| Methods inherited from class org.eclipse.core.runtime.Status |
|---|
getCode, getException, getMessage, getPlugin, getSeverity, isOK, matches, setCode, setException, setMessage, setPlugin, setSeverity |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public MultiStatus(String pluginId,
int code,
IStatus[] newChildren,
String message,
Throwable exception)
pluginId - the unique identifier of the relevant plug-incode - the plug-in-specific status codenewChildren - the list of children status objectsmessage - a human-readable message, localized to the
current localeexception - a low-level exception, or null if not
applicable
public MultiStatus(String pluginId,
int code,
String message,
Throwable exception)
pluginId - the unique identifier of the relevant plug-incode - the plug-in-specific status codemessage - a human-readable message, localized to the
current localeexception - a low-level exception, or null if not
applicable| Method Detail |
|---|
public void add(IStatus status)
status - the new child statuspublic void addAll(IStatus status)
status - the status whose children are to be added to this onepublic IStatus[] getChildren()
IStatus
getChildren in interface IStatusgetChildren in class StatusIStatus.isMultiStatus()public boolean isMultiStatus()
IStatus
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.
isMultiStatus in interface IStatusisMultiStatus in class Statustrue for a multi-status,
false otherwiseIStatus.getChildren()public void merge(IStatus status)
add(status) if the
given status is not a multi-status.
Equivalent to addAll(status) if the
given status is a multi-status.
status - the status to merge into this oneadd(IStatus),
addAll(IStatus)public String toString()
toString in class Status
|
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.