View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *  http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.any23.validator;
19  
20  /**
21   * Models a rule for an issue detection.
22   *
23   * @see Fix
24   * 
25   * @author Michele Mostarda (mostarda@fbk.eu)
26   * @author Davide Palmisano (palmisano@fbk.eu)
27   */
28  public interface Rule {
29  
30      /**
31       * @return returns the human readable name for this rule.
32       */
33      String getHRName();
34  
35      /**
36       * Applies this rule to the given document.
37       *
38       * @param document
39       *            the target document.
40       * @param context
41       *            the context used to pass data to an eventual {@link Fix}.
42       * @param validationReportBuilder
43       *            the report builder used to collect rule reporting.
44       * 
45       * @return <code>true</code> if al least an issue is detected, <code>false</code> otherwise.
46       */
47      boolean applyOn(DOMDocument document, RuleContext<?> context, ValidationReportBuilder validationReportBuilder);
48  
49  }