Package org.eclipse.ltk.core.refactoring
Class RefactoringTickProvider
java.lang.Object
org.eclipse.ltk.core.refactoring.RefactoringTickProvider
Implementors of refactorings uses instances of
RefactoringTickProvider
to specify the tick distribution during progress reporting when executing the
check conditions, create change and change initialization steps.- Since:
- 3.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final RefactoringTickProviderThe default refactoring tick provider -
Constructor Summary
ConstructorsConstructorDescriptionRefactoringTickProvider(int checkInitialConditionsTicks, int checkFinalConditionsTicks, int createChangeTicks, int initializeChangeTicks) Creates a new refactoring tick provider with the given values -
Method Summary
Modifier and TypeMethodDescriptionintSum ofgetCheckConditionsTicks,getCreateChangeTicksandgetInitializeChangeTicks.intSum ofgetCheckInitialConditionsTicks()andgetCheckFinalConditionsTicksintNumber of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#checkFinalConditions().intNumber of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#checkInitialConditions().intNumber of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#createChange().intNumber of ticks reserved in the parent progress monitor for the progress monitor passed towhich is executed on the object returned byChange.initializeValidationData(IProgressMonitor)Refactoring#createChange().
-
Field Details
-
DEFAULT
The default refactoring tick provider
-
-
Constructor Details
-
RefactoringTickProvider
public RefactoringTickProvider(int checkInitialConditionsTicks, int checkFinalConditionsTicks, int createChangeTicks, int initializeChangeTicks) Creates a new refactoring tick provider with the given values- Parameters:
checkInitialConditionsTicks- ticks used in the initial condition check stepcheckFinalConditionsTicks- ticks used in the final condition check stepcreateChangeTicks- ticks used in the create change stepinitializeChangeTicks- ticks used in the change validation steps
-
-
Method Details
-
getAllTicks
public int getAllTicks()Sum ofgetCheckConditionsTicks,getCreateChangeTicksandgetInitializeChangeTicks.- Returns:
- the number of ticks, >= 0
-
getCheckAllConditionsTicks
public int getCheckAllConditionsTicks()Sum ofgetCheckInitialConditionsTicks()andgetCheckFinalConditionsTicks- Returns:
- the number of ticks, >= 0
-
getCheckInitialConditionsTicks
public int getCheckInitialConditionsTicks()Number of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#checkInitialConditions().- Returns:
- the number of ticks, >= 0
-
getCheckFinalConditionsTicks
public int getCheckFinalConditionsTicks()Number of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#checkFinalConditions().- Returns:
- the number of ticks, >= 0
-
getCreateChangeTicks
public int getCreateChangeTicks()Number of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#createChange().- Returns:
- the number of ticks, >= 0
-
getInitializeChangeTicks
public int getInitializeChangeTicks()Number of ticks reserved in the parent progress monitor for the progress monitor passed towhich is executed on the object returned byChange.initializeValidationData(IProgressMonitor)Refactoring#createChange().- Returns:
- the number of ticks, >= 0
-