com.soebes.maven.plugins.mlv
Class LicenseVerifierReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      com.soebes.maven.plugins.mlv.AbstractLicenseVerifierPlugIn
          com.soebes.maven.plugins.mlv.LicenseVerifierReport

All Implemented Interfaces:

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

public class LicenseVerifierReport
extends AbstractLicenseVerifierPlugIn
implements org.apache.maven.reporting.MavenReport

Generate a report about the license verifier report.

Author:

Karl Heinz Marbaise

Field Summary

private File	outputDirectory The directory where the report will be generated
private File	reportOutputDirectory The directory where the report will be generated

Fields inherited from class com.soebes.maven.plugins.mlv.AbstractLicenseVerifierPlugIn

excludes, failOnInvalid, failOnUnknown, failOnValid, failOnWarning, licenseFile, licensesContainer, licenseValidator, localRepository, project, projectBuilder, remoteRepositories

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

LicenseVerifierReport()

Method Summary

boolean	canGenerateReport()
private void	cell(org.codehaus.doxia.sink.Sink sink, String text)
private void	createEmptyCell(org.codehaus.doxia.sink.Sink sink)
private void	createFigure(org.codehaus.doxia.sink.Sink sink, boolean success)
private void	doGenerateArtifactCategories(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink, String scope)
private void	doGenerateEmptyReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink) generates an empty report in case there are no sources to generate a report with
private void	doGenerateInvalidReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink, String scope)
private void	doGenerateItemReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink)
private void	doGenerateLicenseCategories(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink)
private void	doGenerateReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink)
private void	doGenerateReportLicensesConfiguration(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink, String header, List<LicenseItem> licenseItems)
private void	doGenerateUnknownReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink, String scope)
private void	doGenerateValidReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink, String scope)
private void	doGenerateWarningReport(ResourceBundle bundle, org.codehaus.doxia.sink.Sink sink, String scope)
void	execute()
protected void	executeReport(Locale locale)
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
protected ResourceBundle	getBundle(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
protected File	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
File	getReportOutputDirectory()
private boolean	hasInvalidEntries(String scope)
private boolean	hasScope(String scope)
private boolean	hasUnknownEntries(String scope)
private boolean	hasValidEntries(String scope)
private boolean	hasWarningEntries(String scope)
private void	headerCell(org.codehaus.doxia.sink.Sink sink, String text)
boolean	isExternalReport()
void	setOutputDirectory(File outputDirectory)
void	setProject(org.apache.maven.project.MavenProject project)
void	setReportOutputDirectory(File outputDirectory)

Methods inherited from class com.soebes.maven.plugins.mlv.AbstractLicenseVerifierPlugIn

getDependArtifacts, getLicenseInformations, getLicenseList, isVerbose, loadLicensesFile, setVerbose

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

private File outputDirectory

The directory where the report will be generated

reportOutputDirectory

private File reportOutputDirectory

The directory where the report will be generated

Constructor Detail

LicenseVerifierReport

public LicenseVerifierReport()

Method Detail

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

getOutputDirectory

protected File getOutputDirectory()

getProject

protected org.apache.maven.project.MavenProject getProject()

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

getBundle

protected ResourceBundle getBundle(Locale locale)

See Also:

MavenReport.getOutputName()

doGenerateEmptyReport

private void doGenerateEmptyReport(ResourceBundle bundle,
                                   org.codehaus.doxia.sink.Sink sink)

generates an empty report in case there are no sources to generate a report with

Parameters:

bundle - the resource bundle to retrieve report phrases from

sink - the report formatting tool

doGenerateReport

private void doGenerateReport(ResourceBundle bundle,
                              org.codehaus.doxia.sink.Sink sink)

hasScope

private boolean hasScope(String scope)

hasValidEntries

private boolean hasValidEntries(String scope)

hasInvalidEntries

private boolean hasInvalidEntries(String scope)

hasWarningEntries

private boolean hasWarningEntries(String scope)

hasUnknownEntries

private boolean hasUnknownEntries(String scope)

doGenerateLicenseCategories

private void doGenerateLicenseCategories(ResourceBundle bundle,
                                         org.codehaus.doxia.sink.Sink sink)

doGenerateArtifactCategories

private void doGenerateArtifactCategories(ResourceBundle bundle,
                                          org.codehaus.doxia.sink.Sink sink,
                                          String scope)

doGenerateReportLicensesConfiguration

private void doGenerateReportLicensesConfiguration(ResourceBundle bundle,
                                                   org.codehaus.doxia.sink.Sink sink,
                                                   String header,
                                                   List<LicenseItem> licenseItems)

createEmptyCell

private void createEmptyCell(org.codehaus.doxia.sink.Sink sink)

createFigure

private void createFigure(org.codehaus.doxia.sink.Sink sink,
                          boolean success)

doGenerateItemReport

private void doGenerateItemReport(ResourceBundle bundle,
                                  org.codehaus.doxia.sink.Sink sink)

doGenerateValidReport

private void doGenerateValidReport(ResourceBundle bundle,
                                   org.codehaus.doxia.sink.Sink sink,
                                   String scope)

doGenerateWarningReport

private void doGenerateWarningReport(ResourceBundle bundle,
                                     org.codehaus.doxia.sink.Sink sink,
                                     String scope)

doGenerateInvalidReport

private void doGenerateInvalidReport(ResourceBundle bundle,
                                     org.codehaus.doxia.sink.Sink sink,
                                     String scope)

doGenerateUnknownReport

private void doGenerateUnknownReport(ResourceBundle bundle,
                                     org.codehaus.doxia.sink.Sink sink,
                                     String scope)

headerCell

private void headerCell(org.codehaus.doxia.sink.Sink sink,
                        String text)

cell

private void cell(org.codehaus.doxia.sink.Sink sink,
                  String text)

setProject

public void setProject(org.apache.maven.project.MavenProject project)

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

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

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

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