Static Code Analysis in the NetBeans IDE Java Editor

This tutorial needs a review. You can edit it in GitHub following these contribution guidelines.

The NetBeans IDE Java Editor has a static code analysis feature, which is a tool for finding potential problems and detecting inconsistencies in your source code.

In this tutorial, you will learn how to perform static analysis of your Java code using NetBeans Java Hints without actually running your applications.

Requirements

To complete this tutorial, you need the following software and resources.

Software or Resource Version Required

library.zip

NetBeans project

Setting Up the Tutorial Environment

In addition to the required software listed above you should have the following installed on your computer:

  • The library.zip file should be unzipped into your NetBeans project folder and opened in the NetBeans IDE.

Using Predefined Configurations

You can use the following predefined configurations when inspecting your code in the NetBeans IDE:

Running All Analyzers

The All Analyzers configuration deploys all static code analysis tools available in the IDE.

To run the All Analyzers configuration, complete the following steps:

  1. Choose Source > Inspect from the main IDE’s toolbar.

  2. In the Scope drop-down list of the Inspect dialog box, select Current Project (library) .

  3. In the Configuration drop-down list, select the All Analyzers configuration.

allconfig small

  1. Click Inspect. The results of the analysis are displayed in the Inspector Window as a tree view on the left.

all small

The description of the currently selected in the tree view finding is displayed on the right.

alldescription small
If you want to leave some part of your code that is reported as problematic as is, the IDE allows you to suppress the warning for this code to leave it without any changes. You can double-click a warning in the tree view of the Inspector Window to go to the Source Editor.
Press Alt+Enter, click the black arrow pointing to the right at the end of the displayed hint, and choose SuppressWarning - (warning name) .
suppress small

Verifying Java Code against NetBeans Java Hints

The NetBeans Java Hints configuration available in the IDE enables you to verify if the predefined coding standard rules are satisfied by the source code under consideration. In other words, it applies a set of NetBeans Java Hints (also known as code inspections) to your Java source files.

To run the NetBeans Java Hints configuration, complete the following steps:

  1. Choose Source > Inspect from the main IDE’s toolbar.

  2. In the Scope drop-down list of the Inspect dialog box, select Open Projects (if you have only one library project open in the IDE) or Current Project (library) .

You can define a scope (a file, package, or project(s)) for the NetBeans Java Hints configuration.

  1. Select the Configuration radio button and choose NetBeans Java Hints in the drop-down list.

hints small

  1. Click Inspect. The IDE displays the tree view with the results of the analysis with the NetBeans Java Hints configuration in the Inspector Window.

hintsconfig

  1. In the Inspector Window, click the Categorize button in the toolbar on the left to view the problems grouped into categories.

catview

The following table displays the commands available in the Inspector Window.

Icon

Name

Function

refreshbutton

Refresh

Displays a refreshed list of the static analysis results.

upbutton

Previous Problem

Displays the previous problem in the list of the static analysis results.

downbutton

Next Problem

Displays the following problem in the list of the static analysis results.

categorizebutton

Categorize

Toggles the collapsed view of the problems detected in a file, project, or package or the categorized view of all the detected problems.

Customizing a Default Configuration

While working on your code you may need to customize a predefined configuration that includes your own NetBeans Java hints or FindBugs bugs.

To tailor a predefined Default configuration to your own needs, complete the following steps:

  1. Choose Source > Inspect from the main IDE’s toolbar.

  2. In the Inspect dialog box, select the Configuration radio button and select the Default configuration.

  3. Click Manage. The IDE displays the Configurations dialog box.

configurations db

  1. Ensure Default is selected in the Configurations drop-down list.

  2. In the Analyzer drop-down list, select the JRE 8 Profiles Conformance or Netbeans Java Hints analyzer.

  3. Depending on the choice of the analyzer in the previous step, select the profile to validate, the inspections, or bugs you need to include into your Default configuration.

select inspections small

  1. Click OK to save your Default configuration.

Creating and Deleting Configurations

You can create and delete your own configurations to be used in the static analysis of your Java code.

To create a configuration, complete the following steps:

  1. Choose Source > Inspect from the main IDE’s toolbar.

  2. In the Inspect dialog box, select the Configuration radio button and select the Default configuration.

  3. Click Manage.

  4. In the Configurations dialog box, click the black arrow at the end of the Configurations drop-down list and choose New.

newconfig

A newConfig configuration is created and added to the Configurations drop-down list.

newconfig created

  1. In the Analyzer drop-down list, choose JRE 8 Profiles Conformance or Netbeans Java Hints.

  2. Specify the profile, inspections, or bugs to be included into your own configuration.

  3. Click OK to save your edits and close the Configurations dialog box. The created newConfig configuration is available in the Configuration drop-down list of the Inspect dialog box.

newconfig inspect small
To rename a configuration, select the newConfig configuration in the Configurations drop-down list, click the black arrow at the end of the Configurations drop-down list and choose Rename. Type a new name (for example, renamedConfig ) and press Enter to save your edits.
renamedconfig

To delete a configuration, complete the following steps:

  1. Choose Source > Inspect from the main IDE’s toolbar.

  2. In the Inspect dialog box, select the Configuration radio button and select the configuration to be deleted ( renamedConfig in this example).

  3. Click Manage.

  4. In the Configurations dialog box, click the black arrow at the end of the Configurations drop-down list and choose Delete.

delete

  1. In the Delete Configuration dialog box, click Yes to confirm the deletion of the configuration.

delete confirm

The renamedConfig configuration is deleted from the Configurations list.

Refer to the NetBeans Java Hint Module Tutorial for information on how to create a NetBeans module that provides one or more NetBeans Java hints.

Running Single Inspections

You can inspect your code for a particular deficiency in your source code using the static code analysis feature in the NetBeans IDE.

To detect a specific inconsistency or problem in your Java source code with a single inspection, complete the following steps:

  1. Choose Source > Inspect from the main IDE’s menu.

  2. In the Scope drop-down list of the Inspect dialog box, select a file, package, or project(s) to be inspected.

  3. Select Single Inspection and do either of the following:

  • In the Single Inspection drop-down list, scroll and select a single NetBeans Java hint or FindBugs bug to be used in the source code analysis, or

single inspection small

  • Click Browse to open the Configurations dialog box and, in the Analyzer drop-down list, specify the analyzer and then choose a profile (for the JRE 8 Profile Compliance analyzer), a single inspection (for the NetBeans Java Hints analyzer), or a single bug (for the FindBugs analyzer) to be used in the source code analysis. Click OK to close the Configurations dialog box.

hint inspection small

  1. In the Inspect dialog box, click Inspect to perform the source code analysis. After the Inspect operation is completed, the hints that can be applied to your code or bugs that have been found are displayed in the Inspector Window below the Source Editor.

Summary

This tutorial covers most frequent usages of the static code analysis feature in the NetBeans IDE. Please note that with the static code analysis functionality you can also perform custom refactorings at a project scope, or apply particular refactoring configurations to several projects open in the IDE, etc.

top