Coverage Report - org.apache.maven.doxia.linkcheck.validation.LinkValidator
 
Classes in this File Line Coverage Branch Coverage Complexity
LinkValidator
N/A
N/A
1
 
 1  
 package org.apache.maven.doxia.linkcheck.validation;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one
 5  
  * or more contributor license agreements.  See the NOTICE file
 6  
  * distributed with this work for additional information
 7  
  * regarding copyright ownership.  The ASF licenses this file
 8  
  * to you under the Apache License, Version 2.0 (the
 9  
  * "License"); you may not use this file except in compliance
 10  
  * with the License.  You may obtain a copy of the License at
 11  
  *
 12  
  *   http://www.apache.org/licenses/LICENSE-2.0
 13  
  *
 14  
  * Unless required by applicable law or agreed to in writing,
 15  
  * software distributed under the License is distributed on an
 16  
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 17  
  * KIND, either express or implied.  See the License for the
 18  
  * specific language governing permissions and limitations
 19  
  * under the License.
 20  
  */
 21  
 
 22  
 /**
 23  
  * @author <a href="mailto:bwalding@apache.org">Ben Walding</a>
 24  
  * @author <a href="mailto:aheritier@apache.org">Arnaud Heritier</a>
 25  
  * @version $Id: LinkValidator.java 638289 2008-03-18 09:44:10Z bentmann $
 26  
  */
 27  
 public interface LinkValidator
 28  
 {
 29  
     /**
 30  
      * If getResourceKey(lvi) returned null, this will NOT be called.
 31  
      *
 32  
      * @param lvi The LinkValidationItem to validate.
 33  
      * @return The LinkValidationResult.
 34  
      */
 35  
     LinkValidationResult validateLink( LinkValidationItem lvi );
 36  
 
 37  
     /**
 38  
      * The resource key is used by the cache to determine if it really needs to validate the link. No actual validation
 39  
      * should be done at this point.
 40  
      *
 41  
      * @param lvi The LinkValidationItem to validate.
 42  
      * @return Object null if this validator should not be doing this work.
 43  
      */
 44  
     Object getResourceKey( LinkValidationItem lvi );
 45  
 }