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 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

Fields

Modifier and Type	Field	Description
static final RefactoringTickProvider	DEFAULT	The 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

Modifier and Type	Method	Description
int	getAllTicks()	Sum of getCheckConditionsTicks, getCreateChangeTicks and getInitializeChangeTicks.
int	getCheckAllConditionsTicks()	Sum of getCheckInitialConditionsTicks() and getCheckFinalConditionsTicks
int	getCheckFinalConditionsTicks()	Number of ticks reserved in the parent progress monitor of the progress monitor passed to Refactoring#checkFinalConditions().
int	getCheckInitialConditionsTicks()	Number of ticks reserved in the parent progress monitor of the progress monitor passed to Refactoring#checkInitialConditions().
int	getCreateChangeTicks()	Number of ticks reserved in the parent progress monitor of the progress monitor passed to Refactoring#createChange().
int	getInitializeChangeTicks()	Number of ticks reserved in the parent progress monitor for the progress monitor passed to Change.initializeValidationData(IProgressMonitor) which is executed on the object returned by Refactoring#createChange().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final RefactoringTickProvider 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 step

checkFinalConditionsTicks - ticks used in the final condition check step

createChangeTicks - ticks used in the create change step

initializeChangeTicks - ticks used in the change validation steps

Method Details

getAllTicks

public int getAllTicks()

Sum of getCheckConditionsTicks, getCreateChangeTicks and getInitializeChangeTicks.

Returns:

the number of ticks, >= 0

getCheckAllConditionsTicks

public int getCheckAllConditionsTicks()

Sum of getCheckInitialConditionsTicks() and getCheckFinalConditionsTicks

Returns:

the number of ticks, >= 0

getCheckInitialConditionsTicks

public int getCheckInitialConditionsTicks()

Number of ticks reserved in the parent progress monitor of the progress monitor passed to Refactoring#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 to Refactoring#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 to Refactoring#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 to Change.initializeValidationData(IProgressMonitor) which is executed on the object returned by Refactoring#createChange().

Returns:

the number of ticks, >= 0