Java Doc for JBlanketReport.java in  » Code-Analyzer » JBlanket » csdl » jblanket » report » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This is the last step in JBlanket.

There are two main functions of this class:

• Combines the methods invoked during testing in "COVER-*.xml" files into one XML file, where * is the fully qualified name of the test class, then derives the methods that were not tested.
• Calls the AggregateTransformer class to combine JBlanket output and transform them into HTML files.

The above mentioned functions are achieved by invoking the main method. Arguments to pass to the main method include:

Required command line argument:

none.

Optional command line argument:

'enable' - describes if a JBlanket report should be created. Valid values include "true", "on", "yes" to create a report or "false", "off", or "no" to not create a report.
For example: -enable true

'verbose' - describes if report should be created in verbose mode
For example: -verbose true

'reportFormat' - format of the HTML report, either 'frames' or 'noframes'
For example: -reportFormat frames

'toDir' - directory where all HTML files should be sent
For example: -toDir jblanket/html

'excludeOneLineMethods' - describes if one-line methods were excluded
For example: -excludeOneLineMethods false

'excludeConstructors' - describes if constructors were excluded
For example: -excludeConstructors false

'excludeIndividualMethods' - describes if individual methods were excluded
For example: -excludeIndividualMethods false

'totalFile' - name of XML file containing all methods included in the coverage measurement
For example: -totalFile totalMethods.xml

'testedFile' - name of XML file to contain all methods that were tested
For example: -testedFile testedMethods.xml

'untestedFile' - name of XML file to contain all methods that were not tested
For example: -untestedFile untestedMethods.xml

'onelineFile' - name of XML file containing all one-line methods
For example: -oneLineFile oneLineMethods.xml

'constructionFile' - name of XML file containing all constructors
For example: -constructorFile constructorMethods.xml

'excludedIndividualFile' - name of XML file containing all individually excluded methods
For example: -excludedIndividualFile excludedIndividualMethods.xml

Default values are provided for all optional command line arguments and are equivalent to those shown in the examples. Note that values for similar arguments found in csdl.jblanket.modifier.Modifier or csdl.jblanket.app.ExcludeIndividualMethodApp must be set to the same value. For example, if the 'excludeOneLineMethods' argument was set to 'true' and the 'onelinefile' argument was set to 'myOneLineMethods.xml' in the Modifier class, then arguments for 'excludeOneLineMethods' and 'onelinefile' in csdl.jblanket.report.JBlanketReport and csdl.jblanket.app.ExcludeIndividualMethodApp also need to be set to 'true' and 'myOneLineMethods.xml', respectively.

Note that the methods in excludedIndividualFile take priority over all the other methods. I.e., if a one-line method was individually excluded by the application, then it is considered to be an individually excluded methods instead of a one-line method.
author:
   Joy M. Agustin
version:
   $Id: JBlanketReport.java,v 1.3 2005/02/21 20:28:40 timshadel Exp $id

Created for JBlanketReportTask Ant taskdef.

NOTE: Results are rounded to nearest percent while coverage in reports are rounded to the nearest half percent.
throws:
  JBlanketException - if cannot read from totalFile, set in constructor.

Created for JBlanketReportTask Ant taskdef. This method grabs all of the output files from storeMethodTypeSignature method in csdl.jblanket.modifier.MethodCollector and combines the results into a format similar to JUnit.

The command line arguments are as follows:

 '-verbose' - describes if should execute in verbose mode
 '-reportFormat' - format of the HTML report, either 'frames' or 'noframes'
 '-toDir' - directory for HTML output
 '-excludeOneLineMethods' - describes if should exclude one-line methods
 '-excludeConstructors' - describes if should exclude constructors
 '-excludeIndividualMethods' - describes if should exclude individual methods
 '-totalFile' - name of the output XML file for total methods
 '-testedFile' - name of the output XML file to contain all methods that were tested
 '-untestedFile' - name of the output XML file to contain all methods that were not tested
 '-oneLineFile' - name of the output XML file for one-line methods
 '-constructorFile' - name of the output XML file for constructors
 '-excludedIndividualFile' - name of the output XML file for individually excluded methods