org.apache.maven.doxia.linkcheck.validation
Interface LinkValidator

All Known Implementing Classes:

FileLinkValidator, HTTPLinkValidator, MailtoLinkValidator, OfflineHTTPLinkValidator, OnlineHTTPLinkValidator

public interface LinkValidator

Version:

$Id: LinkValidator.java 638289 2008-03-18 09:44:10Z bentmann $

Author:

Ben Walding, Arnaud Heritier

Method Summary

Object	getResourceKey(LinkValidationItem lvi) The resource key is used by the cache to determine if it really needs to validate the link.
LinkValidationResult	validateLink(LinkValidationItem lvi) If getResourceKey(lvi) returned null, this will NOT be called.

Method Detail

validateLink

LinkValidationResult validateLink(LinkValidationItem lvi)

If getResourceKey(lvi) returned null, this will NOT be called.

Parameters:

lvi - The LinkValidationItem to validate.

Returns:

The LinkValidationResult.

getResourceKey

Object getResourceKey(LinkValidationItem lvi)

The resource key is used by the cache to determine if it really needs to validate the link. No actual validation should be done at this point.

Parameters:

lvi - The LinkValidationItem to validate.

Returns:

Object null if this validator should not be doing this work.