org.eclipse.jface.text.reconciler
Interface IReconcileStep

All Known Implementing Classes:

AbstractReconcileStep

public interface IReconcileStep

A reconcile step is one of n steps of a reconcile strategy that consists of several steps.

Since:

3.0

See Also:

IReconcilingStrategy

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 to this reconcile step.

Method Detail

isLastStep

public boolean isLastStep()

Returns whether this is the last reconcile step or not.

Returns:

true if this is the last reconcile step

isFirstStep

public boolean isFirstStep()

Returns whether this is the first reconcile step or not.

Returns:

true if this is the last reconcile step

setPreviousStep

public void setPreviousStep(IReconcileStep step)

Sets the step which is in front of this step in the pipe.

Note: This method must be called at most once per reconcile step.

Parameters:

step - the previous step

Throws:

org.eclipse.jface.text.Assert#AssertionFailedException - if called more than once

reconcile

public IReconcileResult[] reconcile(DirtyRegion dirtyRegion,
                                    IRegion subRegion)

Activates 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 of setDocument.

Parameters:

dirtyRegion - the document region which has been changed

subRegion - the sub region in the dirty region which should be reconciled

Returns:

an array with reconcile results

reconcile

public IReconcileResult[] reconcile(IRegion partition)

Activates 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 into setDocument.

Parameters:

partition - the document partition to be reconciled

Returns:

an array with reconcile results

setProgressMonitor

public void setProgressMonitor(IProgressMonitor monitor)

Sets the progress monitor to this reconcile step.

Parameters:

monitor - the progress monitor to be used

getProgressMonitor

public IProgressMonitor getProgressMonitor()

Returns the progress monitor used to report progress.

Returns:

a progress monitor or null if no progress monitor is provided

setInputModel

public void setInputModel(IReconcilableModel inputModel)

Tells 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 document passed into this method.

Parameters:

inputModel - the model on which this strategy will work