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.io;
28  
29  import gov.nist.secauto.metaschema.databind.model.IBoundNamedInstance;
30  import gov.nist.secauto.metaschema.databind.model.IClassBinding;
31  
32  import java.io.IOException;
33  import java.util.Collection;
34  
35  import edu.umd.cs.findbugs.annotations.NonNull;
36  
37  public abstract class AbstractProblemHandler implements IProblemHandler {
38  
39    @Override
40    public void handleMissingInstances(
41        IClassBinding parentDefinition,
42        Object targetObject,
43        Collection<? extends IBoundNamedInstance> unhandledInstances) throws IOException {
44      applyDefaults(targetObject, unhandledInstances);
45    }
46  
47    /**
48     * A utility method for applying default values for the provided
49     * {@code unhandledInstances}.
50     *
51     * @param <TYPE>
52     *          the instance Java type to handle
53     * @param targetObject
54     *          the Java object to apply default values to
55     * @param unhandledInstances
56     *          the collection of unhandled instances to assign default values for
57     * @throws IOException
58     *           if an error occurred while determining the default value for an
59     *           instance
60     */
61    protected static <TYPE extends IBoundNamedInstance> void applyDefaults(
62        @NonNull Object targetObject,
63        @NonNull Collection<TYPE> unhandledInstances) throws IOException {
64      for (TYPE instance : unhandledInstances) {
65        Object value;
66        try {
67          value = instance.defaultValue();
68        } catch (BindingException ex) {
69          throw new IOException(ex);
70        }
71        if (value != null) {
72          instance.setValue(targetObject, value);
73        }
74      }
75    }
76  }