1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.model.validation;
28
29 import gov.nist.secauto.metaschema.core.model.constraint.IConstraint;
30
31 import java.net.URI;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34
35 /**
36 * Provides information about an individual finding that is the result of a
37 * completed content validation.
38 */
39 public interface IValidationFinding {
40 /**
41 * Get the finding's severity.
42 *
43 * @return the severity
44 */
45 @NonNull
46 IConstraint.Level getSeverity();
47
48 /**
49 * Get the document's URI.
50 *
51 * @return the document's URI
52 */
53 @NonNull
54 URI getDocumentUri();
55 //
56 // /**
57 // * Get the line on which the finding occurred.
58 // *
59 // * @return the line number or {@code null} if unknown
60 // */
61 // Integer getLineNumber();
62 //
63 // /**
64 // * Get the line column on which the finding occurred.
65 // *
66 // * @return the column umber or {@code null} if unknown
67 // */
68 // Integer getColumnNumber();
69
70 /**
71 * Get the finding message.
72 *
73 * @return the message
74 */
75 @NonNull
76 CharSequence getMessage();
77
78 /**
79 * Get the exception associated with the finding.
80 *
81 * @return the {@link Throwable} or {@code null} if no thowable is associated
82 * with the finding
83 */
84 Throwable getCause();
85 }