001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.databind.io;
028
029import gov.nist.secauto.metaschema.databind.model.IBoundNamedInstance;
030import gov.nist.secauto.metaschema.databind.model.IClassBinding;
031
032import java.io.IOException;
033import java.util.Collection;
034
035import edu.umd.cs.findbugs.annotations.NonNull;
036
037public abstract class AbstractProblemHandler implements IProblemHandler {
038
039  @Override
040  public void handleMissingInstances(
041      IClassBinding parentDefinition,
042      Object targetObject,
043      Collection<? extends IBoundNamedInstance> unhandledInstances) throws IOException {
044    applyDefaults(targetObject, unhandledInstances);
045  }
046
047  /**
048   * A utility method for applying default values for the provided
049   * {@code unhandledInstances}.
050   *
051   * @param <TYPE>
052   *          the instance Java type to handle
053   * @param targetObject
054   *          the Java object to apply default values to
055   * @param unhandledInstances
056   *          the collection of unhandled instances to assign default values for
057   * @throws IOException
058   *           if an error occurred while determining the default value for an
059   *           instance
060   */
061  protected static <TYPE extends IBoundNamedInstance> void applyDefaults(
062      @NonNull Object targetObject,
063      @NonNull Collection<TYPE> unhandledInstances) throws IOException {
064    for (TYPE instance : unhandledInstances) {
065      Object value;
066      try {
067        value = instance.defaultValue();
068      } catch (BindingException ex) {
069        throw new IOException(ex);
070      }
071      if (value != null) {
072        instance.setValue(targetObject, value);
073      }
074    }
075  }
076}