com.leafactor.cli.engine

Interface Iteration

All Known Subinterfaces:

RefactoringRule<E>

All Known Implementing Classes:

DrawAllocationRefactoringRule, RecycleRefactoringRule, ViewHolderRefactoringRule, WakeLockRefactoringRule

public interface Iteration

Represents an iteration over the block of statements

Method Summary

Modifier and Type	Method and Description
static void	iterateBlock(RefactoringRule rule, IterationLogger logger, CtBlock block, boolean isDeep, int depth) Iterates over a particular method
static void	iterateMethod(RefactoringRule rule, IterationLogger logger, CtMethod method, boolean isDeep) Iterates over a particular method
void	onDidIterate(DetectionPhaseContext context) Lifecycle method that happens in an individual iteration of the statements on the detection phase and after detecting cases of interest in the particular iteration.
void	onDidRefactorCase(RefactoringPhaseContext context) Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and after refactoring is applied for that particular case of interest.
void	onDidTransformCase(TransformationPhaseContext context) Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and after the transformation is applied for that particular case of interest.
void	onSetup(DetectionPhaseContext context) Lifecycle method that happens before the iteration starts.
void	onWillIterate(DetectionPhaseContext context) Lifecycle method that happens in an individual iteration of the statements on the detection phase and before detecting cases of interest in the particular iteration.
void	onWillRefactor(RefactoringPhaseContext context) Lifecycle method that happens when the detection phase ends and the refactoring phase starts.
void	onWillRefactorCase(RefactoringPhaseContext context) Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and before refactoring is applied for that particular case of interest.
void	onWillTransform(TransformationPhaseContext context) Lifecycle method that happens when the detection phase ends and the transformation phase starts.
void	onWillTransformCase(TransformationPhaseContext context) Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and before the transformation is applied for that particular case of interest.

Method Detail

onSetup

void onSetup(DetectionPhaseContext context)

Lifecycle method that happens before the iteration starts. Helpful for setups.

Parameters:

context - The detection phase context

onWillIterate

void onWillIterate(DetectionPhaseContext context)

Lifecycle method that happens in an individual iteration of the statements on the detection phase and before detecting cases of interest in the particular iteration.

Parameters:

context - The detection phase context

onDidIterate

void onDidIterate(DetectionPhaseContext context)

Lifecycle method that happens in an individual iteration of the statements on the detection phase and after detecting cases of interest in the particular iteration.

Parameters:

context - The detection phase context

onWillTransform

void onWillTransform(TransformationPhaseContext context)

Lifecycle method that happens when the detection phase ends and the transformation phase starts.

Parameters:

context - The transformation phase context

onWillTransformCase

void onWillTransformCase(TransformationPhaseContext context)

Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and before the transformation is applied for that particular case of interest.

Parameters:

context - The transformation phase context

onDidTransformCase

void onDidTransformCase(TransformationPhaseContext context)

Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and after the transformation is applied for that particular case of interest.

Parameters:

context - The transformation phase context

onWillRefactor

void onWillRefactor(RefactoringPhaseContext context)

Lifecycle method that happens when the detection phase ends and the refactoring phase starts.

Parameters:

context - The refactoring phase context

onWillRefactorCase

void onWillRefactorCase(RefactoringPhaseContext context)

Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and before refactoring is applied for that particular case of interest.

Parameters:

context - The refactoring phase context

onDidRefactorCase

void onDidRefactorCase(RefactoringPhaseContext context)

Lifecycle method that happens in an individual iteration of the cases of interest found on the detection phase and after refactoring is applied for that particular case of interest.

Parameters:

context - The refactoring phase context

iterateMethod

static void iterateMethod(RefactoringRule rule,
                          IterationLogger logger,
                          CtMethod method,
                          boolean isDeep)

Iterates over a particular method

Parameters:

rule - The refactoring rule that is applied

logger - The logger for entry logs and performance data

method - The node of the method declaration

isDeep - A flag that describes whether the search will go into inner block's or not.

iterateBlock

static void iterateBlock(RefactoringRule rule,
                         IterationLogger logger,
                         CtBlock block,
                         boolean isDeep,
                         int depth)

Iterates over a particular method

Parameters:

rule - The refactoring rule that is applied

logger - The logger for entry logs and performance data

block - The node of the method declaration

isDeep - A flag that describes whether the search will go into inner block's or not.

depth - An integer representing the current depth of the search