Package org.eclipse.cdt.core.model
Interface ICModelStatus
-
- All Superinterfaces:
org.eclipse.core.runtime.IStatus
public interface ICModelStatus extends org.eclipse.core.runtime.IStatus
Represents the outcome of an C model operation. Status objects are used insideCModelException
objects to indicate what went wrong.C model status object are distinguished by their plug-in id:
getPlugin
returns"org.eclipse.cdt.core"
.getCode
returns one of the status codes declared inICModelStatusConstants
.A C model status may also carry additional information (that is, in addition to the information defined in
IStatus
):- elements - optional handles to C elements associated with the failure
- string - optional string associated with the failure
- See Also:
IStatus
,ICModelStatusConstants
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
doesNotExist()
Returns whether this status indicates that a C model element does not exist.ICElement[]
getElements()
Returns any C elements associated with the failure (see specification of the status code), or an empty array if no elements are related to this particular status code.org.eclipse.core.runtime.IPath
getPath()
Returns the path associated with the failure (see specification of the status code), ornull
if the failure is not one ofDEVICE_PATH
,INVALID_PATH
,PATH_OUTSIDE_PROJECT
, orRELATIVE_PATH
.String
getString()
Returns the string associated with the failure (see specification of the status code), ornull
if no string is related to this particular status code.
-
-
-
Method Detail
-
getElements
ICElement[] getElements()
Returns any C elements associated with the failure (see specification of the status code), or an empty array if no elements are related to this particular status code.- Returns:
- the list of C element culprits
- See Also:
ICModelStatusConstants
-
getPath
org.eclipse.core.runtime.IPath getPath()
Returns the path associated with the failure (see specification of the status code), ornull
if the failure is not one ofDEVICE_PATH
,INVALID_PATH
,PATH_OUTSIDE_PROJECT
, orRELATIVE_PATH
.- Returns:
- the path that caused the failure, or
null
if none - See Also:
ICModelStatusConstants.DEVICE_PATH
,ICModelStatusConstants.INVALID_PATH
,ICModelStatusConstants.PATH_OUTSIDE_PROJECT
,ICModelStatusConstants.RELATIVE_PATH
-
getString
String getString()
Returns the string associated with the failure (see specification of the status code), ornull
if no string is related to this particular status code.- Returns:
- the string culprit, or
null
if none - See Also:
ICModelStatusConstants
-
doesNotExist
boolean doesNotExist()
Returns whether this status indicates that a C model element does not exist. This convenience method is equivalent togetCode() == ICModelStatusConstants.ELEMENT_DOES_NOT_EXIST
.- Returns:
true
if the status code indicates that a C model element does not exist- See Also:
ICModelStatusConstants.ELEMENT_DOES_NOT_EXIST
-
-