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;
28
29 import gov.nist.secauto.metaschema.databind.io.BindingException;
30 import gov.nist.secauto.metaschema.databind.model.info.IDataTypeHandler;
31
32 import java.lang.reflect.Field;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35
36 class ClassBindingFieldProperty
37 extends AbstractFieldProperty {
38
39 @NonNull
40 private final IFieldClassBinding definition;
41
42 /**
43 * Construct a new bound flag instance based on a Java property. The name of the
44 * property is bound to the name of the instance.
45 *
46 * @param field
47 * the Java field to bind to
48 * @param definition
49 * the field's Module definition
50 * @param parentClassBinding
51 * the class binding for the field's containing class
52 */
53 public ClassBindingFieldProperty(
54 @NonNull Field field,
55 @NonNull IFieldClassBinding definition,
56 @NonNull IAssemblyClassBinding parentClassBinding) {
57 super(field, parentClassBinding);
58
59 this.definition = definition;
60
61 if (!isInXmlWrapped()) {
62 if (!definition.isSimple()) { // NOPMD efficiency
63 throw new IllegalStateException(
64 String.format("Field '%s' on class '%s' is requested to be unwrapped, but it has flags preventing this.",
65 field.getName(),
66 parentClassBinding.getBoundClass().getName()));
67 } else if (!getDefinition().getJavaTypeAdapter().isUnrappedValueAllowedInXml()) {
68 throw new IllegalStateException(
69 String.format(
70 "Field '%s' on class '%s' is requested to be unwrapped, but its data type '%s' does not allow this.",
71 field.getName(),
72 parentClassBinding.getBoundClass().getName(),
73 getDefinition().getJavaTypeAdapter().getPreferredName()));
74 }
75 }
76 }
77
78 @Override
79 public final IFieldClassBinding getDefinition() {
80 return definition;
81 }
82
83 @Override
84 protected IDataTypeHandler newDataTypeHandler() {
85 return IDataTypeHandler.newDataTypeHandler(this, getDefinition());
86 }
87
88 @Override
89 public Object defaultValue() throws BindingException {
90 Object retval = null;
91 if (getMaxOccurs() == 1) {
92 IFieldClassBinding definition = getDefinition();
93 IBoundFieldValueInstance fieldValue = definition.getFieldValueInstance();
94
95 Object defaultValue = fieldValue.getDefaultValue();
96 if (defaultValue != null) {
97 retval = definition.newInstance();
98 fieldValue.setValue(retval, defaultValue);
99
100 for (IBoundFlagInstance flag : definition.getFlagInstances()) {
101 Object flagDefault = flag.defaultValue();
102 if (flagDefault != null) {
103 flag.setValue(retval, flagDefault);
104 }
105 }
106 }
107 } else {
108 retval = getPropertyInfo().newPropertyCollector().getValue();
109 }
110 return retval;
111 }
112 }