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 gov.nist.secauto.metaschema.core.util.ObjectUtils;
30
31 import javax.xml.namespace.QName;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34
35 public interface IFlagInstance extends INamedInstance, IFlag {
36
37 @Override
38 IFlagContainer getParentContainer();
39
40 @Override
41 default String getXmlNamespace() {
42 // by default, flags do not have namespaces
43 return null;
44 }
45
46 @NonNull
47 @Override
48 default QName getXmlQName() {
49 // flags always have a qname
50 return ObjectUtils.requireNonNull(INamedInstance.super.getXmlQName());
51 }
52
53 @Override
54 IFlagDefinition getDefinition();
55
56 /**
57 * Determines if a flag value is required to be provided.
58 *
59 * @return {@code true} if a value is required, or {@code false} otherwise
60 */
61 boolean isRequired();
62
63 /**
64 * Determines if this flag's value is used as the property name for the JSON
65 * object that holds the remaining data based on this flag's containing
66 * definition.
67 *
68 * @return {@code true} if this flag is used as a JSON key, or {@code false}
69 * otherwise
70 */
71 default boolean isJsonKey() {
72 IFlagInstance flagInstance = getContainingDefinition().getJsonKeyFlagInstance();
73 return this.equals(flagInstance);
74 }
75
76 /**
77 * Determines if this flag is used as a JSON "value key". A "value key" is a
78 * flag who's value is used as the property name for the containing objects
79 * value.
80 *
81 * @return {@code true} if the flag is used as a JSON "value key", or
82 * {@code false} otherwise
83 */
84 default boolean isJsonValueKey() {
85 IFlagContainer containingDefinition = getContainingDefinition();
86 return containingDefinition instanceof IFieldDefinition
87 && this.equals(((IFieldDefinition) containingDefinition).getJsonValueKeyFlagInstance());
88 }
89 }