Home \ jarnotator

jarnotator - Docs

Finding and annotating code returning null

Last Updated on Monday, 06 September 2010 18:19 Written by jarnotator Sunday, 05 September 2010 07:42

Since version 1.0 the jarnotator (jar annotator) static analysis tool features return null; detection. Meaning that it analyzes bytecode for this pattern and annotates the method with the jsr-305 @javax.annotation.CheckForNull annotation. The excellent static analysis tool findbugs (TM) uses these annotations and can report possible NullPointerException-s.

What jarnotator does in less than 1 minute

Last Updated on Friday, 27 August 2010 06:12 Written by jarnotator Thursday, 19 August 2010 09:33

NullPointerException-s still plague the java world. Commercial programs that throw such exceptions from time to time are unfortunately not so rare. It is here that jarnotator steps in to help addressing this problem. Described in what should amount to less than a minute worth of reading follows what jarnatotor does.

jarnotator on the command line

Last Updated on Tuesday, 24 August 2010 20:14 Written by jarnotator Monday, 16 August 2010 10:01

The jarnotator tool aims at being easy to use. To that end it is also possible to invoke jarnotator on the command line. The command line tools support all the parameters as its ant task and maven2 plugin counterparts.

The command line tool is ideally suited to analyse third party jars since you are less likely to build those from source.

jarnotator parameters explained

Last Updated on Monday, 06 September 2010 20:38 Written by jarnotator Monday, 16 August 2010 09:53

The analysis and subsequent annotation performed by jarnotator can be control by set of parameters. This document describes these different parameters. Each of these options are available whether the standalone jar, Ant task or maven plugin is used. The actual names may differ slightly in the case of the standalone jar. Please refer to the dedicated documentation for the correct values.

Using jarnotator in ant builds

Last Updated on Tuesday, 31 August 2010 20:46 Written by jarnotator Saturday, 14 August 2010 11:17

Using jarnotator in an Ant build

Since jarnotator provides a Ant task it can be used directly from within Apache Ant build scripts. The Ant task provides all the jarnotator options. All in all the Ant task fairly easy to use. Analyzing your classes as part of a build is trivial.

The necessary setup to use the jarnotator task is that of any other external Ant task. The remainder of this page briefly outlines how to get started. For more detailed information please refer to the Apache Ant documentation related to the use of external Ant tasks.