View Javadoc
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.databind.model.test;
28  
29  import gov.nist.secauto.metaschema.core.model.JsonGroupAsBehavior;
30  import gov.nist.secauto.metaschema.databind.model.annotations.BoundAssembly;
31  import gov.nist.secauto.metaschema.databind.model.annotations.BoundField;
32  import gov.nist.secauto.metaschema.databind.model.annotations.GroupAs;
33  import gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaAssembly;
34  
35  import java.util.List;
36  import java.util.Map;
37  
38  @SuppressWarnings("PMD")
39  @MetaschemaAssembly(name = "only-model", moduleClass = TestMetaschema.class)
40  public class OnlyModelBoundAssembly { // NOPMD - intentional
41    /*
42     * ================ = simple field = ================
43     */
44    /**
45     * An optional singleton simple field.
46     */
47    @BoundField(useName = "simple-singleton-field")
48    private String simpleSingletonField;
49  
50    /**
51     * A required singleton simple field.
52     */
53    @BoundField(useName = "simple-required-singleton-field",
54        minOccurs = 1)
55    private String simpleRequiredSingletonField;
56  
57    /**
58     * An optional array field.
59     */
60    @BoundField(useName = "simple-array-field",
61        maxOccurs = -1)
62    @GroupAs(name = "simple-array-field-items",
63        inJson = JsonGroupAsBehavior.LIST)
64    private List<String> simpleArrayField;
65  
66    /**
67     * An required array field.
68     */
69    @BoundField(useName = "simple-required-array-field",
70        minOccurs = 1,
71        maxOccurs = -1)
72    @GroupAs(name = "simple-required-array-field-items",
73        inJson = JsonGroupAsBehavior.LIST)
74    private List<String> simpleRequiredArrayField;
75  
76    /**
77     * An optional singleton or array field.
78     */
79    @BoundField(useName = "simple-singleton-or-array-field",
80        maxOccurs = -1)
81    @GroupAs(name = "simple-singleton-or-array-field-items",
82        inJson = JsonGroupAsBehavior.SINGLETON_OR_LIST)
83    private List<String> simpleSingletonOrArrayField;
84  
85    /*
86     * ================= = flagged field = =================
87     */
88    /**
89     * An optional singleton flagged field.
90     */
91    @BoundField(useName = "flagged-singleton-field")
92    private FlaggedBoundField flaggedSingletonField;
93  
94    /**
95     * A required singleton flagged field.
96     */
97    @BoundField(useName = "flagged-required-singleton-field",
98        minOccurs = 1)
99    private FlaggedBoundField flaggedRequiredSingletonField;
100 
101   /**
102    * An optional array flagged field.
103    */
104   @BoundField(useName = "flagged-array-field",
105       maxOccurs = -1)
106   @GroupAs(name = "flagged-array-field-items",
107       inJson = JsonGroupAsBehavior.LIST)
108   private List<FlaggedBoundField> flaggedArrayField;
109 
110   /**
111    * An required array flagged field.
112    */
113   @BoundField(useName = "flagged-required-array-field",
114       minOccurs = 1,
115       maxOccurs = -1)
116   @GroupAs(name = "flagged-required-array-field-items",
117       inJson = JsonGroupAsBehavior.LIST)
118   private List<FlaggedBoundField> flaggedRequiredArrayField;
119 
120   /**
121    * An optional singleton or array flagged field.
122    */
123   @BoundField(useName = "flagged-singleton-or-array-field",
124       maxOccurs = -1)
125   @GroupAs(name = "flagged-singleton-or-array-field-items",
126       inJson = JsonGroupAsBehavior.SINGLETON_OR_LIST)
127   private List<FlaggedBoundField> flaggedSingletonOrArrayField;
128 
129   /*
130    * ============== = assemblies = ==============
131    */
132   /**
133    * An optional singleton assembly.
134    */
135   @BoundAssembly(useName = "singleton-assembly")
136   private EmptyBoundAssembly singletonAssembly;
137 
138   /**
139    * An optional array assembly.
140    */
141   @BoundAssembly(useName = "array-assembly",
142       maxOccurs = -1)
143   @GroupAs(name = "array-assembly-items",
144       inJson = JsonGroupAsBehavior.LIST)
145   private List<OnlyModelBoundAssembly> arrayAssembly;
146 
147   /**
148    * An optional singleton or array assembly.
149    */
150   @BoundAssembly(useName = "singleton-or-array-assembly",
151       maxOccurs = -1)
152   @GroupAs(name = "singleton-or-array-assembly-items",
153       inJson = JsonGroupAsBehavior.SINGLETON_OR_LIST)
154   private List<OnlyModelBoundAssembly> singletonOrArrayAssembly;
155   /**
156    * An optional keyed assembly.
157    */
158   @BoundAssembly(useName = "keyed-assembly",
159       maxOccurs = -1)
160   @GroupAs(name = "keyed-assembly-items",
161       inJson = JsonGroupAsBehavior.KEYED)
162   private Map<String, FlaggedBoundAssembly> keyedAssembly;
163 }