Coverage Report

Coverage Report - org.apache.any23.validator.ValidationReportBuilder

Classes in this File

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *  http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.apache.any23.validator;
 
 import org.w3c.dom.Node;
 
 /**
  * The report interface is used to generate diagnostics about validation.
  *
  * @author Michele Mostarda (mostarda@fbk.eu)
  * @author Davide Palmisano (palmisano@fbk.eu)
  */
 public interface ValidationReportBuilder {
 
     /**
      * @return Returns the validation report.
      */
     ValidationReport getReport();
 
     /**
      * Reports an issue detected on a specified node.
      *
      * @param issueLevel issue level classifier.
      * @param message human readable message connected to the issue.
      * @param n the node affected by the issue.
      */
     void reportIssue(ValidationReport.IssueLevel issueLevel, String message, Node n);
 
     /**
      * Reports a detected issue.
      *
      * @param issueLevel issue level classifier.
      * @param message human readable message connected to the issue.
      */
     void reportIssue(ValidationReport.IssueLevel issueLevel, String message);
 
     /**
      * Traces that a rule has been applied.
      * 
      * @param r activated rule.
      */
     void traceRuleActivation(Rule r);
 
     /**
      * Reports an error occurred while executing a {@link Rule}.
      *
      * @param r rule originating the error.
      * @param e exception raised.
      * @param msg human readable message.
      */
     void reportRuleError(Rule r, Exception e, String msg);
 
     /**
      * Reports an error occurred while executing a {@link Fix}.
      * 
      * @param f fix originating the error.
      * @param e exception raised.
      * @param msg human readable message.
      */
     void reportFixError(Fix f, Exception e, String msg);
 
 }

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		import org.w3c.dom.Node;
21
22		/**
23		* The report interface is used to generate diagnostics about validation.
24		*
25		* @author Michele Mostarda (mostarda@fbk.eu)
26		* @author Davide Palmisano (palmisano@fbk.eu)
27		*/
28		public interface ValidationReportBuilder {
29
30		/**
31		* @return Returns the validation report.
32		*/
33		ValidationReport getReport();
34
35		/**
36		* Reports an issue detected on a specified node.
37		*
38		* @param issueLevel issue level classifier.
39		* @param message human readable message connected to the issue.
40		* @param n the node affected by the issue.
41		*/
42		void reportIssue(ValidationReport.IssueLevel issueLevel, String message, Node n);
43
44		/**
45		* Reports a detected issue.
46		*
47		* @param issueLevel issue level classifier.
48		* @param message human readable message connected to the issue.
49		*/
50		void reportIssue(ValidationReport.IssueLevel issueLevel, String message);
51
52		/**
53		* Traces that a rule has been applied.
54		*
55		* @param r activated rule.
56		*/
57		void traceRuleActivation(Rule r);
58
59		/**
60		* Reports an error occurred while executing a {@link Rule}.
61		*
62		* @param r rule originating the error.
63		* @param e exception raised.
64		* @param msg human readable message.
65		*/
66		void reportRuleError(Rule r, Exception e, String msg);
67
68		/**
69		* Reports an error occurred while executing a {@link Fix}.
70		*
71		* @param f fix originating the error.
72		* @param e exception raised.
73		* @param msg human readable message.
74		*/
75		void reportFixError(Fix f, Exception e, String msg);
76
77		}