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.constraint;
28
29 import java.util.Map;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32 import edu.umd.cs.findbugs.annotations.Nullable;
33
34 /**
35 * Represents a rule requiring the value of a field or flag to match the name of
36 * one entry in a set of enumerated values.
37 */
38 public interface IAllowedValuesConstraint extends IConstraint {
39 boolean DEFAULT_ALLOW_OTHER = false;
40 @NonNull
41 Extensible DEFAULT_EXTENSIBLE = Extensible.MODEL;
42
43 enum Extensible {
44 /**
45 * Can be extended by external constraints. The most permissive level.
46 */
47 EXTERNAL,
48 /**
49 * Can be extended by constraints in the same model.
50 */
51 MODEL,
52 /**
53 * Cannot be extended. The most restrictive level.
54 */
55 NONE;
56 }
57
58 /**
59 * Get the collection allowed values associated with this constraint.
60 *
61 * @return a mapping of value to the associated {@link IAllowedValue} item
62 */
63 @NonNull
64 Map<String, ? extends IAllowedValue> getAllowedValues();
65
66 /**
67 * Get a specific allowed value by name, if it is defined for this constraint.
68 *
69 * @param name
70 * the value name
71 * @return the allowed value or {@code null} if the value is not defined
72 */
73 @Nullable
74 default IAllowedValue getAllowedValue(String name) {
75 return getAllowedValues().get(name);
76 }
77
78 /**
79 * Determines if this allowed value constraint is open-ended ({@code true}) or
80 * closed. If "open-ended", the constraint allows the target's value to by any
81 * additional unspecified value. If "closed", the constraint requries the
82 * target's value to be one of the specified values.
83 *
84 * @return {@code true} if the constraint is "open-ended", or {@code false}
85 * otherwise
86 */
87 boolean isAllowedOther();
88
89 /**
90 * Determines the degree to which this constraint can be extended by other
91 * constraints applied to the same value.
92 *
93 * @return the enumeration value
94 */
95 @NonNull
96 Extensible getExtensible();
97 }