Class AbstractReconcileStep
- java.lang.Object
-
- org.eclipse.jface.text.reconciler.AbstractReconcileStep
-
- All Implemented Interfaces:
IReconcileStep
public abstract class AbstractReconcileStep extends Object implements IReconcileStep
Abstract implementation of a reconcile step.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description protected IReconcilableModelfInputModel
-
Constructor Summary
Constructors Constructor Description AbstractReconcileStep()Creates the last reconcile step of the pipe.AbstractReconcileStep(IReconcileStep step)Creates an intermediate reconcile step which adds the given step to the pipe.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected IReconcileResult[]convertToInputModel(IReconcileResult[] inputResults)Adapts the given an array with reconcile results to this step's input model and returns it.IReconcilableModelgetInputModel()Returns the reconcilable input model.abstract IReconcilableModelgetModel()Returns the reconcilable model.IProgressMonitorgetProgressMonitor()Returns the progress monitor used to report progress.protected booleanisCanceled()booleanisFirstStep()Returns whether this is the first reconcile step or not.booleanisLastStep()Returns whether this is the last reconcile step or not.IReconcileResult[]reconcile(IRegion partition)Activates non-incremental reconciling.IReconcileResult[]reconcile(DirtyRegion dirtyRegion, IRegion subRegion)Activates incremental reconciling of the specified dirty region.protected abstract IReconcileResult[]reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion)Reconciles the model of this reconcile step.voidsetInputModel(IReconcilableModel inputModel)Tells this reconcile step on which model it will work.voidsetPreviousStep(IReconcileStep step)Sets the step which is in front of this step in the pipe.voidsetProgressMonitor(IProgressMonitor monitor)Sets the progress monitor for this reconcile step.
-
-
-
Field Detail
-
fInputModel
protected IReconcilableModel fInputModel
-
-
Constructor Detail
-
AbstractReconcileStep
public AbstractReconcileStep(IReconcileStep step)
Creates an intermediate reconcile step which adds the given step to the pipe.- Parameters:
step- the reconcile step
-
AbstractReconcileStep
public AbstractReconcileStep()
Creates the last reconcile step of the pipe.
-
-
Method Detail
-
isLastStep
public boolean isLastStep()
Description copied from interface:IReconcileStepReturns whether this is the last reconcile step or not.- Specified by:
isLastStepin interfaceIReconcileStep- Returns:
trueiff this is the last reconcile step
-
isFirstStep
public boolean isFirstStep()
Description copied from interface:IReconcileStepReturns whether this is the first reconcile step or not.- Specified by:
isFirstStepin interfaceIReconcileStep- Returns:
trueiff this is the first reconcile step
-
setProgressMonitor
public void setProgressMonitor(IProgressMonitor monitor)
Description copied from interface:IReconcileStepSets the progress monitor for this reconcile step.- Specified by:
setProgressMonitorin interfaceIReconcileStep- Parameters:
monitor- the progress monitor to be used
-
getProgressMonitor
public IProgressMonitor getProgressMonitor()
Description copied from interface:IReconcileStepReturns the progress monitor used to report progress.- Specified by:
getProgressMonitorin interfaceIReconcileStep- Returns:
- a progress monitor or
nullif no progress monitor is available
-
reconcile
public final IReconcileResult[] reconcile(IRegion partition)
Description copied from interface:IReconcileStepActivates non-incremental reconciling. The reconciling strategy is just told that there are changes and that it should reconcile the given partition of the document most recently passed intoIReconcilingStrategy.setDocument(org.eclipse.jface.text.IDocument).- Specified by:
reconcilein interfaceIReconcileStep- Parameters:
partition- the document partition to be reconciled- Returns:
- an array with reconcile results
-
reconcile
public final IReconcileResult[] reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
Description copied from interface:IReconcileStepActivates incremental reconciling of the specified dirty region. As a dirty region might span multiple content types, the segment of the dirty region which should be investigated is also provided to this reconciling strategy. The given regions refer to the document passed into the most recent call ofIReconcilingStrategy.setDocument(org.eclipse.jface.text.IDocument).- Specified by:
reconcilein interfaceIReconcileStep- Parameters:
dirtyRegion- the document region which has been changedsubRegion- the sub region in the dirty region which should be reconciled- Returns:
- an array with reconcile results
-
reconcileModel
protected abstract IReconcileResult[] reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion)
Reconciles the model of this reconcile step. The result is based on the input model.- Parameters:
dirtyRegion- the document region which has been changedsubRegion- the sub region in the dirty region which should be reconciled- Returns:
- an array with reconcile results
-
convertToInputModel
protected IReconcileResult[] convertToInputModel(IReconcileResult[] inputResults)
Adapts the given an array with reconcile results to this step's input model and returns it.- Parameters:
inputResults- an array with reconcile results- Returns:
- an array with the reconcile results adapted to the input model
-
isCanceled
protected final boolean isCanceled()
-
setPreviousStep
public void setPreviousStep(IReconcileStep step)
Description copied from interface:IReconcileStepSets the step which is in front of this step in the pipe.Note: This method must be called at most once per reconcile step.
- Specified by:
setPreviousStepin interfaceIReconcileStep- Parameters:
step- the previous step
-
setInputModel
public void setInputModel(IReconcilableModel inputModel)
Description copied from interface:IReconcileStepTells this reconcile step on which model it will work. This method will be called before any other method and can be called multiple times. The regions passed to the other methods always refer to the most recent model passed into this method.- Specified by:
setInputModelin interfaceIReconcileStep- Parameters:
inputModel- the model on which this step will work
-
getInputModel
public IReconcilableModel getInputModel()
Returns the reconcilable input model.- Returns:
- the reconcilable input model.
-
getModel
public abstract IReconcilableModel getModel()
Returns the reconcilable model.- Returns:
- the reconcilable model
-
-