|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LinkCheck
Tool to check links from html files in a given directory.
Field Summary | |
---|---|
static String |
ROLE
Plexus Role |
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. |
Field Detail |
---|
static final String ROLE
Method Detail |
---|
void setBasedir(File base)
base
- the base directoryvoid setBaseURL(String url)
url
- the base URL.void setExcludedHttpStatusErrors(int[] excl)
404
, a int[] with excluded errors.
excl
- The excludes to setHttpStatus} for all possible values.
void setExcludedHttpStatusWarnings(int[] excl)
301
, a int[] with excluded errors.
excl
- The excludes to setHttpStatus} for all possible values.
void setExcludedLinks(String[] excl)
http://maven.apache.org/
,
or pattern links i.e. http://maven.apache.org/**/*.html
excl
- The excludes to setvoid setExcludedPages(String[] excl)
excl
- The excludes to setvoid setHttp(HttpBean http)
http
- parameters bean.void setLinkCheckCache(File cacheFile)
cacheFile
- The cacheFile to set. Set this to null to ignore storing the cache.void setOnline(boolean onLine)
onLine
- online mode.void setReportOutput(File file)
file
- the output file.void setReportOutputEncoding(String encoding)
encoding
- The outputEncoding to set.LinkcheckModel execute() throws LinkCheckException
LinkCheck
model.
LinkCheckException
- if anysetBasedir(File)
void setEncoding(String encoding)
encoding
- a valid encoding
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |