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.xml;
28
29 import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
30 import gov.nist.secauto.metaschema.core.model.AbstractChoiceInstance;
31 import gov.nist.secauto.metaschema.core.model.IAssemblyInstance;
32 import gov.nist.secauto.metaschema.core.model.IChoiceInstance;
33 import gov.nist.secauto.metaschema.core.model.IFeatureModelContainer;
34 import gov.nist.secauto.metaschema.core.model.IFieldInstance;
35 import gov.nist.secauto.metaschema.core.model.IModelContainer;
36 import gov.nist.secauto.metaschema.core.model.IModelInstance;
37 import gov.nist.secauto.metaschema.core.model.INamedModelInstance;
38 import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.ChoiceType;
39 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
40
41 import edu.umd.cs.findbugs.annotations.NonNull;
42 import nl.talsmasoftware.lazy4j.Lazy;
43
44 class XmlChoiceInstance
45 extends AbstractChoiceInstance
46 implements IFeatureModelContainer<
47 IModelInstance, INamedModelInstance, IFieldInstance, IAssemblyInstance, IChoiceInstance> {
48 @NonNull
49 private final ChoiceType xmlChoice;
50 @NonNull
51 private final Lazy<XmlModelContainerSupport> modelContainer;
52
53 /**
54 * Constructs a mutually exclusive choice between two possible objects.
55 *
56 * @param xmlChoice
57 * the XML for the choice definition bound to Java objects
58 * @param parent
59 * the parent container, either a choice or assembly
60 */
61 public XmlChoiceInstance(
62 @NonNull ChoiceType xmlChoice,
63 @NonNull IModelContainer parent) {
64 super(parent);
65 this.xmlChoice = xmlChoice;
66 this.modelContainer = ObjectUtils.notNull(Lazy.lazy(() -> new XmlModelContainerSupport(xmlChoice, this)));
67 }
68
69 @Override
70 public XmlModelContainerSupport getModelContainer() {
71 return ObjectUtils.notNull(modelContainer.get());
72 }
73
74 @Override
75 public String getGroupAsName() {
76 // a choice does not have a name
77 return null;
78 }
79
80 /**
81 * Get the underlying XML data.
82 *
83 * @return the underlying XML data
84 */
85 @NonNull
86 protected ChoiceType getXmlChoice() {
87 return xmlChoice;
88 }
89
90 @Override
91 public MarkupMultiline getRemarks() {
92 // TODO: add support when remarks are added
93 return null;
94 }
95 }