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;
28
29 import java.util.Collection;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32 import edu.umd.cs.findbugs.annotations.Nullable;
33
34 /**
35 * This marker interface identifies a type of definition that contains flags,
36 * either a field or assembly.
37 */
38 public interface IFlagContainer extends IDefinition, IContainer {
39 /**
40 * Retrieve the Metaschema definition containing this container.
41 *
42 * @return the containing Metaschema definition
43 */
44 @Override
45 @NonNull
46 IFlagContainer getOwningDefinition();
47
48 @Override
49 INamedModelInstance getInlineInstance();
50
51 /**
52 * Identifies if the field has flags or not, or if it has a complex structure
53 * (i.e, model).
54 *
55 * @return {@code true} if the field has no flags or model, or false otherwise
56 */
57 default boolean isSimple() {
58 return getFlagInstances().isEmpty();
59 }
60
61 /**
62 * Retrieves a flag instance, by the flag's effective name, that is defined on
63 * the containing definition.
64 *
65 * @param name
66 * the flag's name
67 * @return the matching flag instance, or {@code null} if there is no flag
68 * matching the specified name
69 */
70 @Nullable
71 IFlagInstance getFlagInstanceByName(@NonNull String name);
72
73 /**
74 * Retrieves the flag instances for all flags defined on the containing
75 * definition.
76 *
77 * @return the flags
78 */
79 @NonNull
80 Collection<? extends IFlagInstance> getFlagInstances();
81
82 /**
83 * Indicates if a flag's value can be used as a property name in the containing
84 * object in JSON who's value will be the object containing the flag. In such
85 * cases, the flag will not appear in the object. This is only allowed if the
86 * flag is required, as determined by a {@code true} result from
87 * {@link IFlagInstance#isRequired()}. The {@link IFlagInstance} can be
88 * retrieved using {@link #getJsonKeyFlagInstance()}.
89 *
90 * @return {@code true} if the flag's value can be used as a property name, or
91 * {@code false} otherwise
92 * @see #getJsonKeyFlagInstance()
93 */
94 // TODO: remove once moved to the instance side
95 default boolean hasJsonKey() {
96 return getJsonKeyFlagInstance() != null;
97 }
98
99 /**
100 * Retrieves the flag instance to use as as the property name for the containing
101 * object in JSON who's value will be the object containing the flag.
102 *
103 * @return the flag instance if a JSON key is configured, or {@code null}
104 * otherwise
105 * @see #hasJsonKey()
106 */
107 // TODO: remove once moved to the instance side
108 @Nullable
109 IFlagInstance getJsonKeyFlagInstance();
110 }