org.eclipse.cdt.core.cdtvariables
Class CdtVariableStatus

java.lang.Object
  extended by org.eclipse.core.runtime.Status
      extended by org.eclipse.cdt.core.cdtvariables.CdtVariableStatus
All Implemented Interfaces:
ICdtVariableStatus, org.eclipse.core.runtime.IStatus
Direct Known Subclasses:
org.eclipse.cdt.utils.cdtvariables.SupplierBasedCdtVariableStatus

public class CdtVariableStatus
extends org.eclipse.core.runtime.Status
implements ICdtVariableStatus

This class implements the IBuildMacroStatus interface

Since:
3.0

Field Summary
 
Fields inherited from class org.eclipse.core.runtime.Status
CANCEL_STATUS, OK_STATUS
 
Fields inherited from interface org.eclipse.cdt.core.cdtvariables.ICdtVariableStatus
TYPE_ERROR, TYPE_MACRO_NOT_STRING, TYPE_MACRO_NOT_STRINGLIST, TYPE_MACRO_REFERENCE_INCORRECT, TYPE_MACRO_UNDEFINED, TYPE_MACROS_REFERENCE_EACHOTHER
 
Fields inherited from interface org.eclipse.core.runtime.IStatus
CANCEL, ERROR, INFO, OK, WARNING
 
Constructor Summary
CdtVariableStatus(int severity, int code, java.lang.String message, java.lang.Throwable exception, java.lang.String macroName, java.lang.String expression, java.lang.String referencedName)
           
CdtVariableStatus(int code, java.lang.String macroName, java.lang.String expression, java.lang.String referencedName)
          Creates status with the IStatus.ERROR severity and with the default message
CdtVariableStatus(int code, java.lang.String message, java.lang.Throwable exception, java.lang.String macroName, java.lang.String expression, java.lang.String referencedName)
          Creates status with the IStatus.ERROR severity
 
Method Summary
 java.lang.String getExpression()
          returns the string whose resolutinon caused caused this status creation or null if none
 java.lang.String getReferencedMacroName()
          returns the macro name referenced in the resolution string that caused this this status creation or null if none
 java.lang.String getVariableName()
          returns the name of the build macro whose resolution caused this status creation or null if none
 
Methods inherited from class org.eclipse.core.runtime.Status
getChildren, getCode, getException, getMessage, getPlugin, getSeverity, isMultiStatus, isOK, matches, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.runtime.IStatus
getChildren, getCode, getException, getMessage, getPlugin, getSeverity, isMultiStatus, isOK, matches
 

Constructor Detail

CdtVariableStatus

public CdtVariableStatus(int severity,
                         int code,
                         java.lang.String message,
                         java.lang.Throwable exception,
                         java.lang.String macroName,
                         java.lang.String expression,
                         java.lang.String referencedName)
Parameters:
severity - one of the IStatus.xxx severity statuses
code - one of the IBuildMacroStatus.TYPE_xxx statusses
message - message, can be null. In this case the default message will be generated base upon the other status info
exception - a low-level exception, or null if not applicable
macroName - the name of the build macro whose resolution caused this status creation or null if none
expression - the string whose resolutinon caused caused this status creation or null if none
referencedName - the macro name referenced in the resolution string that caused this this status creation or null if none
contextType - the context type used in the operation
contextData - the context data used in the operation

CdtVariableStatus

public CdtVariableStatus(int code,
                         java.lang.String message,
                         java.lang.Throwable exception,
                         java.lang.String macroName,
                         java.lang.String expression,
                         java.lang.String referencedName)
Creates status with the IStatus.ERROR severity

Parameters:
code - one of the IBuildMacroStatus.TYPE_xxx statusses
message - message, can be null. In this case the default message will be generated base upon the other status info
exception - a low-level exception, or null if not applicable
macroName - the name of the build macro whose resolution caused this status creation or null if none
expression - the string whose resolutinon caused caused this status creation or null if none
referencedName - the macro name referenced in the resolution string that caused this this status creation or null if none
contextType - the context type used in the operation
contextData - the context data used in the operation

CdtVariableStatus

public CdtVariableStatus(int code,
                         java.lang.String macroName,
                         java.lang.String expression,
                         java.lang.String referencedName)
Creates status with the IStatus.ERROR severity and with the default message

Parameters:
code - one of the IBuildMacroStatus.TYPE_xxx statusses
exception - a low-level exception, or null if not applicable
macroName - the name of the build macro whose resolution caused this status creation or null if none
expression - the string whose resolutinon caused caused this status creation or null if none
referencedName - the macro name referenced in the resolution string that caused this this status creation or null if none
contextType - the context type used in the operation
contextData - the context data used in the operation
Method Detail

getVariableName

public java.lang.String getVariableName()
Description copied from interface: ICdtVariableStatus
returns the name of the build macro whose resolution caused this status creation or null if none

Specified by:
getVariableName in interface ICdtVariableStatus
Returns:
IBuildMacro

getExpression

public java.lang.String getExpression()
Description copied from interface: ICdtVariableStatus
returns the string whose resolutinon caused caused this status creation or null if none

Specified by:
getExpression in interface ICdtVariableStatus
Returns:
String

getReferencedMacroName

public java.lang.String getReferencedMacroName()
Description copied from interface: ICdtVariableStatus
returns the macro name referenced in the resolution string that caused this this status creation or null if none

Specified by:
getReferencedMacroName in interface ICdtVariableStatus
Returns:
String