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

All Known Implementing Classes:

FileLinkValidator, HTTPLinkValidator, MailtoLinkValidator, OfflineHTTPLinkValidator

public interface LinkValidator

Version:

$Id: LinkValidator.java 532339 2007-04-25 12:28:56Z ltheussl $

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 getResource(lvi) returned null, this will NOT be called.

Method Detail

validateLink

public LinkValidationResult validateLink(LinkValidationItem lvi)
                                  throws Exception

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

Parameters:

lvi -

Returns:

int

Throws:

Exception

getResourceKey

public 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 -

Returns:

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

Throws:

Exception