Package org.eclipse.ltk.core.refactoring
Class RefactoringTickProvider
- java.lang.Object
-
- org.eclipse.ltk.core.refactoring.RefactoringTickProvider
-
public class RefactoringTickProvider extends Object
Implementors of refactorings uses instances ofRefactoringTickProviderto specify the tick distribution during progress reporting when executing the check conditions, create change and change initialization steps.- Since:
- 3.2
-
-
Field Summary
Fields Modifier and Type Field Description static RefactoringTickProviderDEFAULTThe default refactoring tick provider
-
Constructor Summary
Constructors Constructor Description RefactoringTickProvider(int checkInitialConditionsTicks, int checkFinalConditionsTicks, int createChangeTicks, int initializeChangeTicks)Creates a new refactoring tick provider with the given values
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetAllTicks()Sum ofgetCheckConditionsTicks,getCreateChangeTicksandgetInitializeChangeTicks.intgetCheckAllConditionsTicks()Sum ofgetCheckInitialConditionsTicks()andgetCheckFinalConditionsTicksintgetCheckFinalConditionsTicks()Number of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#checkFinalConditions().intgetCheckInitialConditionsTicks()Number of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#checkInitialConditions().intgetCreateChangeTicks()Number of ticks reserved in the parent progress monitor of the progress monitor passed toRefactoring#createChange().intgetInitializeChangeTicks()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().
-
-
-
Field Detail
-
DEFAULT
public static final RefactoringTickProvider DEFAULT
The default refactoring tick provider
-
-
Constructor Detail
-
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 Detail
-
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
-
-