A D E F G H I L M N O R S T U V W

A

addFile(LinkcheckFile) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Method addFile.
addLinkValidator(LinkValidator) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Adds a LinkValidator to this manager.
addResult(LinkcheckFileResult) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Method addResult.
Anchors - Class in org.apache.maven.doxia.linkcheck.validation
A helper class to test if some content matches the given HTML anchor

D

DefaultLinkCheck - Class in org.apache.maven.doxia.linkcheck
The main bean to be called whenever a set of documents should have their links checked.
DefaultLinkCheck() - Constructor for class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
 

E

equals(Object) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Method equals.
equals(Object) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Method equals.
equals(Object) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Method equals.
equals(Object) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Method equals.
equals(Object) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationItem
ERROR - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result: error.
ERROR_LEVEL - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result level: error.
execute() - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Execute the link check.
execute() - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Execute the link check.

F

FileLinkValidator - Class in org.apache.maven.doxia.linkcheck.validation
A link validator solely for files on the local filesystem.
FileLinkValidator(String) - Constructor for class org.apache.maven.doxia.linkcheck.validation.FileLinkValidator
 

G

getAbsolutePath() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Get the file to check as String Object.
getAddDefaultEntities() - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
Returns the state of the "add default entities" flag.
getBaseURL() - Method in class org.apache.maven.doxia.linkcheck.validation.OnlineHTTPLinkValidator
The base URL.
getCachedResult(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Returns a LinkValidationResult for the given LinkValidationItem if it has been cached from a previous run, returns null otherwise.
getErrorMessage() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Get the error message.
getErrorMessage() - Method in class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidationResult
Returns the errorMessage.
getErrorMessage() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationResult
Returns the errorMessage.
getExcludedLinks() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Returns the excludedLinks.
getFiles() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Method getFiles.
getHttpClientParameters() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
 
getHttpStatusCode() - Method in class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidationResult
Returns the httpStatusCode.
getLink() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationItem
Returns the link.
getMethod() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the HTTP method to use.
getModelEncoding() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Get the modelEncoding field.
getNumberOfLinks(int) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Get the number of links for this file depending the level wanted.
getNumberOfLinks() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Get the number of links for this file.
getProxyHost() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the proxy host.
getProxyNtlmDomain() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the proxy NTLM (NT Lan Manager) domain.
getProxyNtlmHost() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the proxy NTLM (NT Lan Manager) host.
getProxyPassword() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the proxy password.
getProxyPort() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the proxy port.
getProxyUser() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the proxy user.
getRelativePath() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Get the relative path of the file.
getResourceKey(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.FileLinkValidator
The resource key is used by the cache to determine if it really needs to validate the link.
getResourceKey(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidator
The resource key is used by the cache to determine if it really needs to validate the link.
getResourceKey(LinkValidationItem) - Method in interface org.apache.maven.doxia.linkcheck.validation.LinkValidator
The resource key is used by the cache to determine if it really needs to validate the link.
getResourceKey(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.MailtoLinkValidator
The resource key is used by the cache to determine if it really needs to validate the link.
getResults() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Method getResults.
getSource() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationItem
Returns the source file.
getStatus() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Get the status.
getStatus() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationResult
Returns the status.
getStatusLevel() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Returns the status as an integer.
getSuccessful() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Get the number of successful links in this file.
getTarget() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Get the target URL.
getTimeout() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get the timeout to be used.
getUnsuccessful() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Get the number of unsuccessful links in this file.
getValidators() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Returns the list of validators.

H

hashCode() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationItem
HttpBean - Class in org.apache.maven.doxia.linkcheck
Http bean to encapsulate the supported HTTP parameters.
HttpBean() - Constructor for class org.apache.maven.doxia.linkcheck.HttpBean
 
HTTPLinkValidationResult - Class in org.apache.maven.doxia.linkcheck.validation
This class is used to return HTTP status responses from the validation handlers.
HTTPLinkValidationResult(int, boolean, String) - Constructor for class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidationResult
Constructor: initializes status, persistent and errorMessage.
HTTPLinkValidationResult(int, boolean, int, String) - Constructor for class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidationResult
Constructor: initializes status, persistent, httpStatusCode and errorMessage.
HTTPLinkValidator - Class in org.apache.maven.doxia.linkcheck.validation
Checks links which are normal URLs.
HTTPLinkValidator() - Constructor for class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidator
 

I

isFollowRedirects() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Get if the HTTP method should automatically follow HTTP redirects (status code 302, etc.), false otherwise.
isPersistent() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationResult
Returns the persistent property.

L

LinkCheck - Interface in org.apache.maven.doxia.linkcheck
Tool to check links from html files in a given directory.
LinkCheckException - Exception in org.apache.maven.doxia.linkcheck
Encapsulate a Link check exception.
LinkCheckException(String) - Constructor for exception org.apache.maven.doxia.linkcheck.LinkCheckException
Construct a new LinkCheckException with the specified detail message.
LinkCheckException(String, Throwable) - Constructor for exception org.apache.maven.doxia.linkcheck.LinkCheckException
Construct a new LinkCheckException with the specified detail message and cause.
LinkcheckFile - Class in org.apache.maven.doxia.linkcheck.model
The <file> to be checked.
LinkcheckFile() - Constructor for class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
 
LinkcheckFileResult - Class in org.apache.maven.doxia.linkcheck.model
An class containing the results of a single check of a link.
LinkcheckFileResult() - Constructor for class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
 
LinkcheckModel - Class in org.apache.maven.doxia.linkcheck.model
The <linkcheck> element is the root of the linkcheck descriptor.
LinkcheckModel() - Constructor for class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
 
LinkcheckModelXpp3Reader - Class in org.apache.maven.doxia.linkcheck.model.io.xpp3
Class LinkcheckModelXpp3Reader.
LinkcheckModelXpp3Reader() - Constructor for class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
 
LinkcheckModelXpp3Writer - Class in org.apache.maven.doxia.linkcheck.model.io.xpp3
Class LinkcheckModelXpp3Writer.
LinkcheckModelXpp3Writer() - Constructor for class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Writer
 
LinkValidationItem - Class in org.apache.maven.doxia.linkcheck.validation
 
LinkValidationItem(File, String) - Constructor for class org.apache.maven.doxia.linkcheck.validation.LinkValidationItem
Constructor: initializes the source and link.
LinkValidationResult - Class in org.apache.maven.doxia.linkcheck.validation
This class is used to return status responses from the validation handlers.
LinkValidationResult(int, boolean, String) - Constructor for class org.apache.maven.doxia.linkcheck.validation.LinkValidationResult
Constructor: initializes status, persistent and errorMessage.
LinkValidator - Interface in org.apache.maven.doxia.linkcheck.validation
 
LinkValidatorManager - Class in org.apache.maven.doxia.linkcheck.validation
A LinkValidator manager which manages validators with a cache.
LinkValidatorManager() - Constructor for class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
 
loadCache(File) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Loads a cache file.

M

MailtoLinkValidator - Class in org.apache.maven.doxia.linkcheck.validation
Validates mailto links.
MailtoLinkValidator() - Constructor for class org.apache.maven.doxia.linkcheck.validation.MailtoLinkValidator
 
matchesAnchor(String, String) - Static method in class org.apache.maven.doxia.linkcheck.validation.Anchors
Returns true if the given anchor can be found in the content markup.
matchPattern(String, String) - Static method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
 

N

NOTMINE - Static variable in class org.apache.maven.doxia.linkcheck.validation.LinkValidationResult
Validation result level: not mine.

O

OfflineHTTPLinkValidator - Class in org.apache.maven.doxia.linkcheck.validation
Fake links check when maven is offline
OfflineHTTPLinkValidator() - Constructor for class org.apache.maven.doxia.linkcheck.validation.OfflineHTTPLinkValidator
 
OnlineHTTPLinkValidator - Class in org.apache.maven.doxia.linkcheck.validation
Checks links which are normal URLs
OnlineHTTPLinkValidator() - Constructor for class org.apache.maven.doxia.linkcheck.validation.OnlineHTTPLinkValidator
Constructor: initialize settings, use "head" method.
OnlineHTTPLinkValidator(HttpBean) - Constructor for class org.apache.maven.doxia.linkcheck.validation.OnlineHTTPLinkValidator
Constructor: initialize settings.
org.apache.maven.doxia.linkcheck - package org.apache.maven.doxia.linkcheck
 
org.apache.maven.doxia.linkcheck.model - package org.apache.maven.doxia.linkcheck.model
 
org.apache.maven.doxia.linkcheck.model.io.xpp3 - package org.apache.maven.doxia.linkcheck.model.io.xpp3
 
org.apache.maven.doxia.linkcheck.validation - package org.apache.maven.doxia.linkcheck.validation
 

R

read(Reader, boolean) - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
 
read(Reader) - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
 
read(InputStream, boolean) - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
Method read.
read(InputStream) - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
Method read.
removeFile(LinkcheckFile) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Method removeFile.
removeResult(LinkcheckFileResult) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Method removeResult.
ROLE - Static variable in interface org.apache.maven.doxia.linkcheck.LinkCheck
Plexus Role

S

saveCache(File) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Saves a cache file.
setAbsolutePath(String) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Set the file to check as String Object.
setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Reader
Sets the state of the "add default entities" flag.
setBasedir(File) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Set the base directory for the files to be linkchecked.
setBasedir(File) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Set the base directory for the files to be linkchecked.
setBaseURL(String) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the base URL.
setBaseURL(String) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the base URL.
setBaseURL(String) - Method in class org.apache.maven.doxia.linkcheck.validation.OnlineHTTPLinkValidator
Sets the base URL.
setCachedResult(Object, LinkValidationResult) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Puts the given LinkValidationResult into the cache.
setEncoding(String) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Set the encoding to use when processing files.
setEncoding(String) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Set the encoding to use when processing files.
setErrorMessage(String) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Set the error message.
setExcludedHttpStatusErrors(int[]) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the excluded HTTP errors, i.e.
setExcludedHttpStatusErrors(int[]) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the excluded HTTP errors, i.e.
setExcludedHttpStatusWarnings(int[]) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the excluded HTTP warnings, i.e.
setExcludedHttpStatusWarnings(int[]) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the excluded HTTP warnings, i.e.
setExcludedLinks(String[]) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the excluded links, a String[] with excluded locations.
setExcludedLinks(String[]) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the excluded links, a String[] with excluded locations.
setExcludedLinks(String[]) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Sets the excludedLinks.
setExcludedPages(String[]) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the excluded pages, a String[] with excluded locations.
setExcludedPages(String[]) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the excluded pages, a String[] with excluded locations.
setFiles(List) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Set list of <file> elements.
setFollowRedirects(boolean) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set if the HTTP method should automatically follow HTTP redirects (status code 302, etc.), false otherwise.
setHttp(HttpBean) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the http parameters bean.
setHttp(HttpBean) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the http parameters bean.
setHttpClientParameters(Properties) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
 
setLinkCheckCache(File) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the cache File.
setLinkCheckCache(File) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the cache File.
setMethod(String) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the HTTP method to use.
setModelEncoding(String) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Set the modelEncoding field.
setOnline(boolean) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Set the online mode.
setOnline(boolean) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Set the online mode.
setProxyHost(String) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the proxy host.
setProxyNtlmDomain(String) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the proxy NTLM (NT Lan Manager) domain.
setProxyNtlmHost(String) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the proxy NTLM (NT Lan Manager) host.
setProxyPassword(String) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the proxy password.
setProxyPort(int) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the proxy port.
setProxyUser(String) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the proxy user.
setRelativePath(String) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Set the relative path of the file.
setReportOutput(File) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Set the output file for the results.
setReportOutput(File) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Set the output file for the results.
setReportOutputEncoding(String) - Method in class org.apache.maven.doxia.linkcheck.DefaultLinkCheck
Sets the outputEncoding.
setReportOutputEncoding(String) - Method in interface org.apache.maven.doxia.linkcheck.LinkCheck
Sets the outputEncoding.
setResults(List) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Set all error details in this file.
setStatus(String) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Set the status.
setSuccessful(int) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Set the number of successful links in this file.
setTarget(String) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Set the target URL.
setTimeout(int) - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Set the timeout to be used.
setUnsuccessful(int) - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Set the number of unsuccessful links in this file.

T

toString() - Method in class org.apache.maven.doxia.linkcheck.HttpBean
Method toString.
toString() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFile
Method toString.
toString() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Method toString.
toString() - Method in class org.apache.maven.doxia.linkcheck.model.LinkcheckModel
Method toString.
toString() - Method in class org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidationResult
toString() - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidationResult

U

UNKNOWN - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result: unknown.
UNKNOWN_LEVEL - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result level: unknown.

V

VALID - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result: valid.
VALID_LEVEL - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result level: valid.
validateLink(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.FileLinkValidator
If getResourceKey(lvi) returned null, this will NOT be called.
validateLink(LinkValidationItem) - Method in interface org.apache.maven.doxia.linkcheck.validation.LinkValidator
If getResourceKey(lvi) returned null, this will NOT be called.
validateLink(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.LinkValidatorManager
Validates the links of the given LinkValidationItem.
validateLink(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.MailtoLinkValidator
If getResourceKey(lvi) returned null, this will NOT be called.
validateLink(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.OfflineHTTPLinkValidator
If getResourceKey(lvi) returned null, this will NOT be called.
validateLink(LinkValidationItem) - Method in class org.apache.maven.doxia.linkcheck.validation.OnlineHTTPLinkValidator
If getResourceKey(lvi) returned null, this will NOT be called.

W

WARNING - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result: warning.
WARNING_LEVEL - Static variable in class org.apache.maven.doxia.linkcheck.model.LinkcheckFileResult
Validation result level: warning.
write(Writer, LinkcheckModel) - Method in class org.apache.maven.doxia.linkcheck.model.io.xpp3.LinkcheckModelXpp3Writer
Method write.

A D E F G H I L M N O R S T U V W

Copyright © 2005-2011 Apache Software Foundation. All Rights Reserved.