Checklist for a new cleanup rule

This page holds a checklist that every refactoring rules must follow for providing good quality:

Documentation

• Name

• Description

Code

• Create test examples with:

  • sample code before refactoring (samples_in)

  • sample code after refactoring (samples_out)

• Create the new refactoring rule under org.autorefactor.jdt.internal.ui.fix

  • enable it by adding it to AllCleanUpRules.getAllCleanUpRules()

  • The refactoring rules must be automatically enabled only when applicable. For example an API may only be available for Java > 1.5