org.apache.maven.plugins.linkcheck
Class LinkcheckReportGenerator

java.lang.Object
  org.apache.maven.plugins.linkcheck.LinkcheckReportGenerator

public class LinkcheckReportGenerator
extends Object

Since:

1.1

Author:

ltheussl

Constructor Summary

LinkcheckReportGenerator(org.codehaus.plexus.i18n.I18N i18n)

Method Summary

void	generateReport(Locale locale, org.apache.maven.doxia.linkcheck.model.LinkcheckModel linkcheckModel, org.apache.maven.doxia.sink.Sink sink) Genarate a report for the given LinkcheckModel and emit it into a Sink.
void	setExcludedHttpStatusErrors(Integer[] excludedHttpStatusErrors)
void	setExcludedHttpStatusWarnings(Integer[] excludedHttpStatusWarnings)
void	setExcludedLinks(String[] excludedLinks)
void	setExcludedPages(String[] excludedPages)
void	setHttpFollowRedirect(boolean httpFollowRedirect)
void	setHttpMethod(String httpMethod)
void	setOffline(boolean offline)

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkcheckReportGenerator

public LinkcheckReportGenerator(org.codehaus.plexus.i18n.I18N i18n)

Parameters:

i18n - not null.

Method Detail

setExcludedHttpStatusErrors

public void setExcludedHttpStatusErrors(Integer[] excludedHttpStatusErrors)

Parameters:

excludedHttpStatusErrors - may be null.

setExcludedHttpStatusWarnings

public void setExcludedHttpStatusWarnings(Integer[] excludedHttpStatusWarnings)

Parameters:

excludedHttpStatusWarnings - may be null.

setExcludedLinks

public void setExcludedLinks(String[] excludedLinks)

Parameters:

excludedLinks - may be null.

setExcludedPages

public void setExcludedPages(String[] excludedPages)

Parameters:

excludedPages - may be null.

setHttpFollowRedirect

public void setHttpFollowRedirect(boolean httpFollowRedirect)

Parameters:

httpFollowRedirect - default is false.

setHttpMethod

public void setHttpMethod(String httpMethod)

Parameters:

httpMethod - may be null.

setOffline

public void setOffline(boolean offline)

Parameters:

offline - default is false.

generateReport

public void generateReport(Locale locale,
                           org.apache.maven.doxia.linkcheck.model.LinkcheckModel linkcheckModel,
                           org.apache.maven.doxia.sink.Sink sink)

Genarate a report for the given LinkcheckModel and emit it into a Sink. Note that the Sink is flushed and closed.

Parameters:

locale - not null.

linkcheckModel - may be null.

sink - not null.