de.smartics.maven.util.report
Class MavenExternalReportFactory

java.lang.Object
  de.smartics.maven.util.report.MavenExternalReportFactory

All Implemented Interfaces:

ExternalReportFactory

public class MavenExternalReportFactory
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      ExternalReportFactory
     
     

Factory to create external reports within a Maven project.

Field Summary

static String	MAVEN_COBERTURA_PLUGIN The artifact ID of the cobertura plugin.
static String	MAVEN_JAVADOC_PLUGIN The artifact ID of the Javadoc plugin.
static String	MAVEN_JXR_PLUGIN The artifact ID of the jxr plugin.
static String	MAVEN_SUREFIRE_PLUGIN The artifact ID of the surefire plugin.

Constructor Summary

MavenExternalReportFactory(Log log, MavenProject project, String reportRelDir)
Default constructor.

MavenExternalReportFactory(MavenProject project, String reportRelDir)
Convenience constructor using no logging.

Method Summary

ExternalReport

createExternalReport(ReportId reportId, LinkConstructorStrategy strategy) Constructs an external report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAVEN_SUREFIRE_PLUGIN

public static final String MAVEN_SUREFIRE_PLUGIN

The artifact ID of the surefire plugin.

The value of this constant is "maven-surefire-report-plugin".

Constant Field Value:

"maven-surefire-report-plugin"

MAVEN_JAVADOC_PLUGIN

public static final String MAVEN_JAVADOC_PLUGIN

The artifact ID of the Javadoc plugin.

The value of this constant is "maven-javadoc-plugin".

Constant Field Value:

"maven-javadoc-plugin"

MAVEN_JXR_PLUGIN

public static final String MAVEN_JXR_PLUGIN

The artifact ID of the jxr plugin.

The value of this constant is "maven-jxr-plugin".

Constant Field Value:

"maven-jxr-plugin"

MAVEN_COBERTURA_PLUGIN

public static final String MAVEN_COBERTURA_PLUGIN

The artifact ID of the cobertura plugin.

The value of this constant is "maven-cobertura-plugin".

Constant Field Value:

"maven-cobertura-plugin"

Constructor Detail

MavenExternalReportFactory

public MavenExternalReportFactory(MavenProject project,
                                  String reportRelDir)
                           throws IllegalArgumentException

Convenience constructor using no logging.

Parameters:

project - the Maven project.

reportRelDir - the project's relative path within the project.

Throws:

IllegalArgumentException - if project is null or reportRelDir is null or contains only whitespaces.

MavenExternalReportFactory

public MavenExternalReportFactory(Log log,
                                  MavenProject project,
                                  String reportRelDir)
                           throws IllegalArgumentException

Default constructor.

Parameters:

log - the Maven logger to use.

project - the Maven project.

reportRelDir - the project's relative path within the project.

Throws:

IllegalArgumentException - if project is null or reportRelDir is null or contains only whitespaces.

Method Detail

createExternalReport

public ExternalReport createExternalReport(ReportId reportId,
                                           LinkConstructorStrategy strategy)

Constructs an external report.

Specified by:

createExternalReport in interface ExternalReportFactory

Parameters:

reportId - the identifier of the external report to create.

strategy - the strategy of the report.

Returns:

the instance of the external report or null if no report data is provided.