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.json;
028
029import gov.nist.secauto.metaschema.databind.io.IProblemHandler;
030import gov.nist.secauto.metaschema.databind.model.IClassBinding;
031
032import java.io.IOException;
033
034import edu.umd.cs.findbugs.annotations.NonNull;
035import edu.umd.cs.findbugs.annotations.Nullable;
036
037public interface IJsonProblemHandler extends IProblemHandler {
038
039  /**
040   * Callback used to handle a JSON property that is unknown to the model being
041   * parsed.
042   *
043   * @param classBinding
044   *          the bound class currently describing the data being parsed
045   * @param targetObject
046   *          the Java object for the {@code parentDefinition}
047   * @param fieldName
048   *          the unknown JSON field name
049   * @param parsingContext
050   *          the JSON parsing context used for parsing
051   * @return {@code true} if the attribute was handled by this method, or
052   *         {@code false} otherwise
053   * @throws IOException
054   *           if an error occurred while handling the unrecognized data
055   */
056  boolean handleUnknownProperty(
057      @NonNull IClassBinding classBinding,
058      @Nullable Object targetObject,
059      @NonNull String fieldName,
060      @NonNull IJsonParsingContext parsingContext) throws IOException;
061}