com.puresoltechnologies.maven.plugins.license

Class ReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

com.puresoltechnologies.maven.plugins.license.ReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

@Mojo(name="generate-report",
      requiresDirectInvocation=false,
      requiresProject=true,
      requiresReports=true,
      requiresOnline=false,
      inheritByDefault=true,
      threadSafe=true,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      requiresDependencyCollection=COMPILE_PLUS_RUNTIME)
 @Execute(goal="generate-report",
         phase=GENERATE_SOURCES)
public class ReportMojo
extends AbstractValidationMojo
implements org.apache.maven.reporting.MavenReport

This maven mojo generates a license report out of information generated by a former 'validate' goal run.

Author:

Rick-Rainer Ludwig

Field Summary

Fields

Modifier and Type	Field and Description
protected File	outputDirectory Specifies the destination directory where documentation is to be saved to.

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ReportMojo()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	execute()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File outputDirectory)

Methods inherited from class com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

getArtifacts, getMavenProject, getProjectBuilder, loadArtifacts

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

outputDirectory

@Parameter(property="destDir",
           alias="destDir",
           defaultValue="${project.build.directory}/licenses",
           required=true)
protected File outputDirectory

Specifies the destination directory where documentation is to be saved to.

Constructor Detail

ReportMojo

public ReportMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File outputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport