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   * This interface models a fix for an issue.
22   *
23   * @see Rule
24   * @author Michele Mostarda (mostarda@fbk.eu)
25   * @author Davide Palmisano (palmisano@fbk.eu)
26   */
27  public interface Fix {
28  
29      /**
30       * @return the human readable name for this fix.
31       */
32      String getHRName();
33  
34      /**
35       * Executes this fix over a document.
36       *
37       * @param rule the rule triggering this fix.
38       * @param context the rule context for this fix.
39       * @param document the document to apply this fix.
40       */
41      void execute(Rule rule, @SuppressWarnings("rawtypes") RuleContext context, DOMDocument document);
42  
43  }