org.apache.maven.plugins.linkcheck
Class LinkcheckReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugins.linkcheck.LinkcheckReport

All Implemented Interfaces:

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

public class LinkcheckReport
extends org.apache.maven.reporting.AbstractMavenReport

Generates a Linkcheck report.

Since:

1.0

Version:

$Id: LinkcheckReport.java 1021298 2010-10-11 10:18:19Z ltheussl $

Author:

Vincent Siveton

Is defined by the goal name:

linkcheck

Field Summary

protected static java.lang.String	ICON_ERROR
protected static java.lang.String	ICON_INFO
protected static java.lang.String	ICON_SUCCESS
protected static java.lang.String	ICON_WARNING
protected java.io.File	linkcheckCache The location of the Linkcheck cache file.
protected java.io.File	linkcheckOutput The location of the Linkcheck report file.

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

LinkcheckReport()

Method Summary

boolean	canGenerateReport()
void	execute()
protected void	executeReport(java.util.Locale locale)
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale)
protected java.lang.String	getOutputDirectory()
java.lang.String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()

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

closeReport, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, setReportOutputDirectory

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

linkcheckCache

protected java.io.File linkcheckCache

The location of the Linkcheck cache file.

Is defined by:

default-value:

${project.build.directory}/linkcheck/linkcheck.cache

Is required.

linkcheckOutput

protected java.io.File linkcheckOutput

The location of the Linkcheck report file.

Is defined by:

default-value:

${project.build.directory}/linkcheck/linkcheck.xml

Is required.

ICON_SUCCESS

protected static final java.lang.String ICON_SUCCESS

See Also:

Constant Field Values

ICON_WARNING

protected static final java.lang.String ICON_WARNING

See Also:

Constant Field Values

ICON_INFO

protected static final java.lang.String ICON_INFO

See Also:

Constant Field Values

ICON_ERROR

protected static final java.lang.String ICON_ERROR

See Also:

Constant Field Values

Constructor Detail

LinkcheckReport

public LinkcheckReport()

Method Detail

getDescription

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

getName

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

getOutputName

public java.lang.String getOutputName()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

execute

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

Specified by:

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

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getOutputDirectory

protected java.lang.String getOutputDirectory()

Specified by:

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

getProject

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

Specified by:

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

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

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

executeReport

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException