|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReconcileStep
A reconcile step is one of several steps of a reconcile strategy that consists of several steps. This relationship is not coded into an interface but should be used by clients who's reconcile strategy consists of several steps.
If a reconcile step has an input model
it will compute the correct model for the next step in the chain and set the next steps
input model before reconcile
gets called on that next step. After the last
step has reconciled the reconcile result
array gets returned to the previous step. Each step in the chain adapts the result to its
input model and returns it to its previous step.
Example: Assume a strategy consists of steps A, B and C. And the main model is M. The strategy will set M to be A's input model. What will happen is:
This interface must be implemented by clients.
Method Summary | |
---|---|
IProgressMonitor |
getProgressMonitor()
Returns the progress monitor used to report progress. |
boolean |
isFirstStep()
Returns whether this is the first reconcile step or not. |
boolean |
isLastStep()
Returns whether this is the last reconcile step or not. |
IReconcileResult[] |
reconcile(DirtyRegion dirtyRegion,
IRegion subRegion)
Activates incremental reconciling of the specified dirty region. |
IReconcileResult[] |
reconcile(IRegion partition)
Activates non-incremental reconciling. |
void |
setInputModel(IReconcilableModel inputModel)
Tells this reconcile step on which model it will work. |
void |
setPreviousStep(IReconcileStep step)
Sets the step which is in front of this step in the pipe. |
void |
setProgressMonitor(IProgressMonitor monitor)
Sets the progress monitor for this reconcile step. |
Method Detail |
---|
boolean isLastStep()
true
iff this is the last reconcile stepboolean isFirstStep()
true
iff this is the first reconcile stepvoid setPreviousStep(IReconcileStep step)
Note: This method must be called at most once per reconcile step.
step
- the previous step
java.lang.RuntimeException
- if called more than onceIReconcileResult[] reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
IReconcilingStrategy.setDocument(org.eclipse.jface.text.IDocument)
.
dirtyRegion
- the document region which has been changedsubRegion
- the sub region in the dirty region which should be reconciled
IReconcileResult[] reconcile(IRegion partition)
IReconcilingStrategy.setDocument(org.eclipse.jface.text.IDocument)
.
partition
- the document partition to be reconciled
void setProgressMonitor(IProgressMonitor monitor)
monitor
- the progress monitor to be usedIProgressMonitor getProgressMonitor()
null
if no progress monitor is availablevoid setInputModel(IReconcilableModel inputModel)
inputModel
- the model on which this step will work
|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.