| org.eclipse.ui.ide.undo.AbstractWorkspaceOperation org.eclipse.ui.ide.undo.AbstractMarkersOperation
All known Subclasses: org.eclipse.ui.ide.undo.UpdateMarkersOperation, org.eclipse.ui.ide.undo.DeleteMarkersOperation, org.eclipse.ui.ide.undo.CreateMarkersOperation,
AbstractMarkersOperation | abstract class AbstractMarkersOperation extends AbstractWorkspaceOperation (Code) | | An AbstractMarkersOperation represents an undoable operation that affects
markers on a resource. It provides implementations for marker creation,
deletion, and updating. Clients may call the public API from a background
thread.
This class is not intended to be subclassed by clients.
since: 3.3 |
Constructor Summary | |
| AbstractMarkersOperation(IMarker[] markers, MarkerDescription[] markerDescriptions, Map attributes, String name) Create an AbstractMarkersOperation by specifying a combination of markers
and attributes or marker descriptions.
Parameters: markers - the markers used in the operation or null if nomarkers yet exist Parameters: markerDescriptions - the marker descriptions that should be used to create markers,or null if the markers already exist Parameters: attributes - The map of attributes that should be assigned to any existingmarkers when the markers are updated. |
markers | IMarker[] markers(Code) | | |
AbstractMarkersOperation | AbstractMarkersOperation(IMarker[] markers, MarkerDescription[] markerDescriptions, Map attributes, String name)(Code) | | Create an AbstractMarkersOperation by specifying a combination of markers
and attributes or marker descriptions.
Parameters: markers - the markers used in the operation or null if nomarkers yet exist Parameters: markerDescriptions - the marker descriptions that should be used to create markers,or null if the markers already exist Parameters: attributes - The map of attributes that should be assigned to any existingmarkers when the markers are updated. Ignored if the markersparameter is null . Parameters: name - the name used to describe the operation |
computeExecutionStatus | public IStatus computeExecutionStatus(IProgressMonitor monitor)(Code) | | |
computeRedoableStatus | public IStatus computeRedoableStatus(IProgressMonitor monitor)(Code) | | |
computeUndoableStatus | public IStatus computeUndoableStatus(IProgressMonitor monitor)(Code) | | |
createMarkers | protected void createMarkers(int work, IProgressMonitor monitor) throws CoreException(Code) | | Create markers from any currently known marker descriptions.
Parameters: work - the number of work ticks to be used by the create Parameters: monitor - the progress monitor to use for the create throws: CoreException - propagates any CoreExceptions thrown from the resources API |
deleteMarkers | protected void deleteMarkers(int work, IProgressMonitor monitor) throws CoreException(Code) | | Delete any currently known markers and save their information in marker
descriptions so that they can be restored.
Parameters: work - the number of work ticks to be used by the delete Parameters: monitor - the progress monitor to use for the delete throws: CoreException - propagates any CoreExceptions thrown from the resources API |
getBasicRedoStatus | abstract protected IStatus getBasicRedoStatus()(Code) | | Return a status indicating the projected outcome of redoing the marker
operation. The receiver is not responsible for remembering the result of
this computation.
the status indicating whether the operation can be undone |
getBasicUndoStatus | abstract protected IStatus getBasicUndoStatus()(Code) | | Return a status indicating the projected outcome of undoing the marker
operation. The receiver is not responsible for remembering the result of
this computation.
the status indicating whether the operation can be undone |
getExecuteSchedulingRule | protected ISchedulingRule getExecuteSchedulingRule()(Code) | | |
getMarkerCreationStatus | protected IStatus getMarkerCreationStatus()(Code) | | Compute the status for creating any known markers. A status severity of
OK indicates that the create is likely to be successful. A
status severity of ERROR indicates that the operation is
no longer valid. Other status severities are open to interpretation by
the caller.
the status indicating the projected outcome of creating themarkers. |
getMarkerDeletionStatus | protected IStatus getMarkerDeletionStatus()(Code) | | Compute the status for deleting any known markers. A status severity of
OK indicates that the delete is likely to be successful. A
status severity of ERROR indicates that the operation is
no longer valid. Other status severities are open to interpretation by
the caller.
the status indicating the projected outcome of deleting themarkers. |
getMarkerUpdateStatus | protected IStatus getMarkerUpdateStatus()(Code) | | Compute the status for updating any known markers. A status severity of
OK indicates that the update is likely to be successful. A
status severity of ERROR indicates that the operation is
no longer valid. Other status severities are open to interpretation by
the caller.
the status indicating the projected outcome of updating themarkers. |
getMarkers | public IMarker[] getMarkers()(Code) | | Return the array of markers that has been updated or created.
the array of markers that have been updated or created, ornull if no markers have been created or updated. |
getUndoSchedulingRule | protected ISchedulingRule getUndoSchedulingRule()(Code) | | |
markersExist | protected boolean markersExist()(Code) | | Return whether the markers known by this operation currently exist.
true if there are existing markers andfalse if there are no known markers or any one ofthem does not exist |
setMarkerDescriptions | protected void setMarkerDescriptions(MarkerDescription[] descriptions)(Code) | | Set the marker descriptions that describe markers that can be created.
Parameters: descriptions - the descriptions of markers that can be created. |
updateMarkers | protected void updateMarkers(int work, IProgressMonitor monitor, boolean mergeAttributes) throws CoreException(Code) | | Update the currently known markers with the corresponding array of marker
descriptions.
Parameters: work - the number of work ticks to be used by the update Parameters: monitor - the progress monitor to use for the update Parameters: mergeAttributes - a boolean specifying whether the attributes are merged orconsidered to be a replacement of the previous attributes. throws: CoreException - propagates any CoreExceptions thrown from the resources API |
|
|