TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.core.quickfix
Class AbstractAnalysisQuickFix

java.lang.Object
  extended by org.eclipse.tptp.platform.analysis.core.quickfix.AbstractAnalysisQuickFix
All Implemented Interfaces:
org.eclipse.core.runtime.IExecutableExtension, IAnalysisQuickFix
Direct Known Subclasses:
CppCodeReviewQuickFix, JavaCodeReviewQuickFix

public abstract class AbstractAnalysisQuickFix
extends java.lang.Object
implements IAnalysisQuickFix

This class supplies functionality that is common to all quickfixes. All analysis quickfix classes should extend this.


Constructor Summary
AbstractAnalysisQuickFix()
           
 
Method Summary
 java.lang.String getId()
           
 java.lang.String getLabel()
           
abstract  org.eclipse.core.runtime.IStatus quickfix(AbstractAnalysisResult result)
          Execute the quickfix
 void setId(java.lang.String newId)
          Allows a custom quickfix to define its own id
 void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
           
 void setLabel(java.lang.String newLabel)
          Allows a custom quickfix to define its own label
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractAnalysisQuickFix

public AbstractAnalysisQuickFix()
Method Detail

quickfix

public abstract org.eclipse.core.runtime.IStatus quickfix(AbstractAnalysisResult result)
Execute the quickfix

Specified by:
quickfix in interface IAnalysisQuickFix
Parameters:
result - The result to be quickfiexed
Returns:
a status

setInitializationData

public final void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                        java.lang.String propertyName,
                                        java.lang.Object data)
Specified by:
setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

getId

public final java.lang.String getId()
Specified by:
getId in interface IAnalysisQuickFix
Returns:
The id of this quickfix

setId

public final void setId(java.lang.String newId)
Allows a custom quickfix to define its own id

Parameters:
newId - The id for the quickfix

getLabel

public final java.lang.String getLabel()
Specified by:
getLabel in interface IAnalysisQuickFix
Returns:
The label of this quickfix

setLabel

public final void setLabel(java.lang.String newLabel)
Allows a custom quickfix to define its own label

Parameters:
newLabel - The label for the quickfix

TPTP 4.5.0 Platform Project
Public API Specification