LinkcheckReport (Apache Maven Linkcheck Plugin 1.2 API)

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

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="linkcheck")
public class LinkcheckReport
extends AbstractMavenReport
```
Generates a Linkcheck report.

Since:

1.0

Version:

$Id: LinkcheckReport.java 1628568 2014-09-30 22:19:10Z hboutemy $

Author:

Vincent Siveton

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ICON_ERROR`
`protected static String`	`ICON_INFO`
`protected static String`	`ICON_SUCCESS`
`protected static String`	`ICON_WARNING`
`protected File`	`linkcheckCache` The location of the Linkcheck cache file.
`protected File`	`linkcheckOutput` The location of the Linkcheck report file.

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
outputDirectory, project, siteRenderer

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

LinkcheckReport()

Constructors
Constructor and Description
`LinkcheckReport()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canGenerateReport()`
`void`	`execute()`
`protected void`	`executeReport(Locale locale)`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`String`	`getOutputName()`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, 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

@Parameter(defaultValue="${project.build.directory}/linkcheck/linkcheck.cache",
           required=true)
protected File linkcheckCache

The location of the Linkcheck cache file.

linkcheckOutput

@Parameter(defaultValue="${project.build.directory}/linkcheck/linkcheck.xml",
           required=true)
protected File linkcheckOutput

The location of the Linkcheck report file.

ICON_SUCCESS

protected static final String ICON_SUCCESS

See Also:: Constant Field Values

ICON_WARNING

protected static final String ICON_WARNING

See Also:: Constant Field Values

ICON_INFO

protected static final String ICON_INFO

See Also:: Constant Field Values

ICON_ERROR

protected static final String ICON_ERROR

See Also:: Constant Field Values

Constructor Detail
- LinkcheckReport
```
public LinkcheckReport()
```

Method Detail
- getDescription
```
public String getDescription(Locale locale)
```
- getName
```
public String getName(Locale locale)
```
- getOutputName
```
public String getOutputName()
```
- canGenerateReport
```
public boolean canGenerateReport()
```
  Specified by:
  
  canGenerateReport in interface MavenReport
  
  Overrides:
  
  canGenerateReport in class AbstractMavenReport
- execute
```
public void execute()
             throws MojoExecutionException
```
  Specified by:
  
  execute in interface Mojo
  
  Overrides:
  
  execute in class AbstractMavenReport
  
  Throws:
  
  MojoExecutionException
- executeReport
```
protected void executeReport(Locale locale)
                      throws MavenReportException
```
  Specified by:
  
  executeReport in class AbstractMavenReport
  
  Throws:
  
  MavenReportException

Class LinkcheckReport

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

linkcheckCache

linkcheckOutput

ICON_SUCCESS

ICON_WARNING

ICON_INFO

ICON_ERROR

Constructor Detail

LinkcheckReport

Method Detail

getDescription

getName

getOutputName

canGenerateReport

execute

executeReport