com.atlassian.clover.api.ci.package-info Maven / Gradle / Ivy

Go to download
/**
 *
 * Provides classes to programtically integrate Clover into an Ant or Maven2 build, typically from
 * within a Continuous Integration server.
 *
 * Clover can be integrated into both Ant and Maven2 purely by decorating the respective command lines.
 * This api adds a nice wrapper around creating the appropriate list of arguments to add to the command line depending
 * on what options an end user has configured.
 * 
 * The {@link com.atlassian.clover.api.ci.CIOptions.Builder} should be used to create and configure a
 * {@link CIOptions} instance that then gets passed to one of the {@link com.atlassian.clover.api.ci.Integrator.Factory}'s
 * "new*" methods.
 *
 * 
Examples
 * To integrate Clover into an Ant build, with the default set of options you would use:
 *  *  CIOptions options =  new CIOptions.Builder().build();
 *  Integrator antIntegrator = Integrator.Factory.newAntIntegrator(options);
 *  List args = new ArrayList(Arrays.asList("clean","test"));
 *  antIntegrator.decorateArguments(args);
 *
 *  // args now contain extra args that will enable Clover to instrument all java source files and generate a coverage report.
 *
 * 
 *
 *
 * Related Documentation
 *
 * For more information relating to Clover integration, please view the
 * 
 * Clover for Ant User Guide
 * 
Clover for Maven2 User Guide
 * 
 *
 * If you have any problems using this api, or feature requests please don't hesitate to create a JIRA.
 * @since 2.6.0
 */
package com.atlassian.clover.api.ci;