org.apache.maven.report.projectinfo
Class LicenseReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.report.projectinfo.AbstractProjectInfoReport
              org.apache.maven.report.projectinfo.LicenseReport

All Implemented Interfaces:

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

public class LicenseReport
extends AbstractProjectInfoReport

Generates the Project License report.

Since:

2.0

Version:

$Id: LicenseReport.java 679796 2008-07-25 13:14:34Z vsiveton $

Author:

Vincent Siveton

Is defined by the goal name:

license

Field Summary

Fields inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport

factory, i18n, localRepository, outputDirectory, project, resolver, siteRenderer, siteTool

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

LicenseReport()

Method Summary

boolean	canGenerateReport()
void	executeReport(java.util.Locale locale)
java.lang.String	getDescription(java.util.Locale locale)
protected static java.net.URL	getLicenseURL(org.apache.maven.project.MavenProject project, java.lang.String url)
java.lang.String	getName(java.util.Locale locale)
java.lang.String	getOutputName()

Methods inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport

execute, getCategoryName, getOutputDirectory, getProject, getReportOutputDirectory, getSiteRenderer, setReportOutputDirectory

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, generate, getSink, isExternalReport

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

Constructor Detail

LicenseReport

public LicenseReport()

Method Detail

getName

public java.lang.String getName(java.util.Locale locale)

getDescription

public java.lang.String getDescription(java.util.Locale locale)

executeReport

public void executeReport(java.util.Locale locale)

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

getOutputName

public java.lang.String getOutputName()

getLicenseURL

protected static java.net.URL getLicenseURL(org.apache.maven.project.MavenProject project,
                                            java.lang.String url)
                                     throws java.net.MalformedURLException,
                                            java.io.IOException

Parameters:

project - not null

url - not null

Returns:

a valid URL object from the url string

Throws:

java.net.MalformedURLException - if any

java.io.IOException - if any