The tool for scanning adopter breakages are developed as part of the Eclipse API scanner. The Eclipse API scanner is available as two Eclipse plug-ins. You can overlay them on top of any Eclipse 3.1+ drivers.

1. Download the Eclipse API scanner and unzip it on top of your Eclipse driver.
2. Start Eclipse.

1. First, you need to configure the location of the adopter usage reports. These reports are committed to dev.eclipse.org:/cvsroot/webtools/releng.wtptools/api/adopter_usages. Check out the adopter_usages folder from CVS.
2. To configure the adopter usage reports, go to preferences. Select the Adopter Usage Reports tab.

   

3. Click Add and choose the project(s) that contains the adopter usage reports. Click Browse and choose the folder where you want the breakage reports to be generated into. Click OK to exit out of preferences.

   

4. You now have everything setup. You can continue with your day-to-day development. Before you commit your code into CVS, make sure you scan your code for adopter breakages. For this tutorial, we will use the org.eclipse.wst.server.core plug-in as an example. Check out the org.eclipse.wst.server.core plug-in from CVS.
5. In the Resources perspective, right click on the org.eclipse.wst.server.core project, select API and choose Scan for breakages.

   

6. You should receive a popup indicating that the org.eclipse.wst.server.core plug-in is compatible with the adopter usage reports.

   

7. Now, we will remove an method from the one of the Java source and scan again. Open the servercore/org/eclipse/wst/server/core/IServer.java in the Java editor, scroll down to the bottom of the file and comment out the restartModule(IModule[] module, IOperationListener listener) method and save.

   

8. Right click on the org.eclipse.wst.server.core project again, select API and choose Scan for breakages.
9. After the operation completes, the Adopter Breakages View will open and you will find all the adopter breakages in this view.

   

10. The Adopter Breakages view is structured in the following format:
    • Plugin
      • Contact information of the adopter
        • Classes that are used by this adopter. Classes that show up here means either they are removed, or one or more of their methods/fields are removed.
          • Removed methods that are used by this adopter
          • Removed fields that are used by this adopter
    You should either restore the removed classes/methods/fields or notify the adopter that these classes/methods/fields will be removed in the coming builds. Please refer to the non-API deprecation policy for details on what to do in this case.