Package com.iizigo.quickfix
Interface IQuickFixer
- All Superinterfaces:
org.eclipse.ui.IMarkerResolution
- All Known Implementing Classes:
CloseProjectQuickFixer
,CreateModuleFolders
,DeleteFile
,DeleteProperty
,DeleteRect
,GotoProperty
,OpenProperty
,QuickFixAdapter
,RecoverModuleSettings
,RenameResource
public interface IQuickFixer extends org.eclipse.ui.IMarkerResolution
Interface the quick-fix for a marker implements to resolve it's and possibly others of the same type. When run, a resolution would typically eliminate the need for the marker, or open up editing of the problem, e.g. an errored property definition.- Author:
- Christopher Mindus
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getLabel()
Returns a short label indicating what the resolution will do.boolean
isMarkerRequired()
Indicates if the label returned and also the description depends on the marker selected.void
run(org.eclipse.core.resources.IMarker marker)
Runs this resolution.void
setMarker(org.eclipse.core.resources.IMarker marker)
Call to set the marker in a new instance of the quick-fixer.
Method Detail
run
void run(org.eclipse.core.resources.IMarker marker)
Runs this resolution.- Specified by:
run
in interfaceorg.eclipse.ui.IMarkerResolution
- Parameters:
marker
- the marker to resolve.
getLabel
java.lang.String getLabel()
Returns a short label indicating what the resolution will do. A quick-fixer that returns true toisMarkerRequired()
will have the marker set and can be retrieved usinggetMarker()
if it extends theQuickFixAdapter
class.- Specified by:
getLabel
in interfaceorg.eclipse.ui.IMarkerResolution
- Returns:
- A short label for this resolution.
isMarkerRequired
boolean isMarkerRequired()
Indicates if the label returned and also the description depends on the marker selected.In case this method returns true, a new Quick-Fix of the same instance is created followed by
setMarker(marker)
.A quick-fixer that returns true to
isMarkerRequired()
will have the marker set and can be retrieved usinggetMarker()
if it extends theQuickFixAdapter
class.
setMarker
void setMarker(org.eclipse.core.resources.IMarker marker)
Call to set the marker in a new instance of the quick-fixer.- Parameters:
marker
- The marker.