org.apache.maven.doxia.linkcheck.validation
Class FileLinkValidator

java.lang.Object
  extended by org.apache.maven.doxia.linkcheck.validation.FileLinkValidator
All Implemented Interfaces:
LinkValidator

public final class FileLinkValidator
extends Object
implements LinkValidator

A link validator solely for files on the local filesystem.

Version:
$Id: FileLinkValidator.java 1030039 2010-11-02 13:33:03Z ltheussl $
Author:
Ben Walding, Arnaud Heritier

Constructor Summary
FileLinkValidator(String encoding)
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileLinkValidator

public FileLinkValidator(String encoding)
Parameters:
encoding - the encoding file used. If empty, using UTF-8.
Method Detail

validateLink

public LinkValidationResult validateLink(LinkValidationItem lvi)
If getResourceKey(lvi) returned null, this will NOT be called.

Specified by:
validateLink in interface LinkValidator
Parameters:
lvi - The LinkValidationItem to validate.
Returns:
The LinkValidationResult.

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.

Specified by:
getResourceKey in interface LinkValidator
Parameters:
lvi - The LinkValidationItem to validate.
Returns:
Object null if this validator should not be doing this work.


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