Java Impact Reports

Reports generated by the Create Java Impact Report action are presented in a three-paned window following the ‘Javadoc’ standard:

  • The top left pane lists the report packages available, and the namespaces from the analyzed class files. ‘Global’ is used for classes that are not assigned to a namespace. Select a namespace to display its classes in the lower left pane. Each namespace is marked with an icon to indicate its overall comparison status.
Icon Description

Row Same icon.

The item is the same in the ‘Lefts’ and ‘Rights’ classes.

Row Different icon.

The item is different in the ‘Lefts’ and ‘Rights’ classes.

Row In 1 icon.

The item exists in the ‘Lefts’ classes only.

Row In 2 icon.

The item exists in the ‘Rights’ classes only.

  • The lower left pane lists the classes that were retrieved or compared. Each class is marked with an icon as described above to indicate its overall comparison status.
  • The Details pane displays details for the selected report package or class.

Statistics

If ‘Statistics’ is selected from the top left pane, the Details pane displays a summary of the objects in the report.

  • The ‘Tokens’ section displays a comparison summary for each of the tokens in the report.
  • The ‘Files’ section lists the number of archives and class files in the report.
  • If an Impact Analysis report is generated, the ‘Impact Report’ section displays a summary showing the number of impacted and non-impacted classes in the report.

Text Files Analysis

If ‘Text Files Analysis’ is selected from the top left pane, a list of the text files associated with the Java class files analyzed is shown in the lower left pane. The files are organized into subfolders named ‘Left Files’ and ‘Right Files’. Each text file object is marked with one the comparison status icons listed above.

Select a text file to display its contents in the Details pane. If a text file has been compared in two sets of Java classes, the files are displayed side by side, and lines in the text file are colored to indicate their comparison status.

  • Lines that are the same are shown with a grey background.
  • Lines that are different are shown in red with a yellow background.
  • Lines that exist in the left file only are shown with a green background.
  • Lines that exist in the right file only are shown with a pink background.

Impact Analysis

If ‘Impact Analysis’ is selected from the top left pane, the Details Pane displays a hierarchy showing classes from the ‘Tops’ action property, and whether they are likely to be impacted by differences between the ‘Lefts’ and ‘Rights’ classes.

Impacted classes are marked with Red Octagon icon., classes that are not impacted are marked with Green Octagon icon.. Select a class link to display the details for the selected class. Each class link is marked with an icon as described above to indicate its overall comparison status.

Classes

If a class is selected from the lower left pane or from an Impact Analysis report, the Details pane displays the interfaces, fields, methods and attributes for the selected class. The ‘Methods’ section has three columns:

  • The first column lists the name of the method. Each method is marked with an icon as described above to indicate its comparison status. Note that because Java supports overloading (two methods may have the same name and different arguments), it is not possible to mark a method as ‘Different’.
  • The second column lists the Java data types for each method’s arguments and return values. The argument list is shown first in parentheses, followed by the return values.
  • The third column indicates the type of each method.