|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.linkcheck.DefaultLinkCheck
public final class DefaultLinkCheck
The main bean to be called whenever a set of documents should have their links checked.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.linkcheck.LinkCheck |
---|
ROLE |
Constructor Summary | |
---|---|
DefaultLinkCheck()
|
Method Summary | |
---|---|
LinkcheckModel |
execute()
Execute the link check. |
void |
setBasedir(File base)
Set the base directory for the files to be linkchecked. |
void |
setBaseURL(String url)
Sets the base URL. |
void |
setEncoding(String encoding)
Set the encoding to use when processing files. |
void |
setExcludedHttpStatusErrors(int[] excl)
Sets the excluded HTTP errors, i.e. |
void |
setExcludedHttpStatusWarnings(int[] excl)
Sets the excluded HTTP warnings, i.e. |
void |
setExcludedLinks(String[] excl)
Sets the excluded links, a String[] with excluded locations. |
void |
setExcludedPages(String[] excl)
Sets the excluded pages, a String[] with excluded locations. |
void |
setHttp(HttpBean http)
Sets the http parameters bean. |
void |
setLinkCheckCache(File cacheFile)
Sets the cache File. |
void |
setOnline(boolean onLine)
Set the online mode. |
void |
setReportOutput(File file)
Set the output file for the results. |
void |
setReportOutputEncoding(String encoding)
Sets the outputEncoding. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultLinkCheck()
Method Detail |
---|
public void setBasedir(File base)
setBasedir
in interface LinkCheck
base
- the base directorypublic void setBaseURL(String url)
setBaseURL
in interface LinkCheck
url
- the base URL.public void setExcludedHttpStatusErrors(int[] excl)
404
, a int[] with excluded errors.
setExcludedHttpStatusErrors
in interface LinkCheck
excl
- The excludes to setHttpStatus} for all possible values.
public void setExcludedHttpStatusWarnings(int[] excl)
301
, a int[] with excluded errors.
setExcludedHttpStatusWarnings
in interface LinkCheck
excl
- The excludes to setHttpStatus} for all possible values.
public void setExcludedLinks(String[] excl)
http://maven.apache.org/
,
or pattern links i.e. http://maven.apache.org/**/*.html
setExcludedLinks
in interface LinkCheck
excl
- The excludes to setpublic void setExcludedPages(String[] excl)
setExcludedPages
in interface LinkCheck
excl
- The excludes to setpublic void setHttp(HttpBean http)
setHttp
in interface LinkCheck
http
- parameters bean.public void setLinkCheckCache(File cacheFile)
setLinkCheckCache
in interface LinkCheck
cacheFile
- The cacheFile to set. Set this to null to ignore storing the cache.public void setOnline(boolean onLine)
setOnline
in interface LinkCheck
onLine
- online mode.public void setReportOutput(File file)
setReportOutput
in interface LinkCheck
file
- the output file.public void setReportOutputEncoding(String encoding)
setReportOutputEncoding
in interface LinkCheck
encoding
- The outputEncoding to set.public LinkcheckModel execute() throws LinkCheckException
execute
in interface LinkCheck
LinkCheck
model.
LinkCheckException
- if anyLinkCheck.setBasedir(File)
public void setEncoding(String encoding)
setEncoding
in interface LinkCheck
encoding
- a valid encoding
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |