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.Level;
30
31 import java.util.Collections;
32 import java.util.List;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35
36 /**
37 * Provides data that is the result of a completed content validation.
38 */
39 public interface IValidationResult {
40 @NonNull
41 IValidationResult PASSING_RESULT = new IValidationResult() {
42
43 @Override
44 public boolean isPassing() {
45 return true;
46 }
47
48 @Override
49 public Level getHighestSeverity() {
50 return Level.INFORMATIONAL;
51 }
52
53 @SuppressWarnings("null")
54 @Override
55 public List<? extends IValidationFinding> getFindings() {
56 return Collections.emptyList();
57 }
58 };
59
60 /**
61 * Determines if the result of validation was valid or not.
62 *
63 * @return {@code true} if the result was determined to be valid or
64 * {@code false} otherwise
65 */
66 default boolean isPassing() {
67 return getHighestSeverity().ordinal() < Level.ERROR.ordinal();
68 }
69
70 /**
71 * Get the highest finding severity level for the validation. The level
72 * {@link Level#INFORMATIONAL} will be returned if no validation findings were
73 * identified.
74 *
75 * @return the highest finding severity level
76 */
77 @NonNull
78 Level getHighestSeverity();
79
80 /**
81 * Get the list of validation findings, which may be empty.
82 *
83 * @return the list
84 */
85 @NonNull
86 List<? extends IValidationFinding> getFindings();
87 }