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.json;
28
29 import com.fasterxml.jackson.core.JsonGenerator;
30
31 import gov.nist.secauto.metaschema.databind.io.IWritingContext;
32 import gov.nist.secauto.metaschema.databind.model.IBoundNamedInstance;
33 import gov.nist.secauto.metaschema.databind.model.IClassBinding;
34
35 import java.io.IOException;
36 import java.util.Map;
37
38 import edu.umd.cs.findbugs.annotations.NonNull;
39
40 public interface IJsonWritingContext extends IWritingContext<JsonGenerator> {
41 /**
42 * Write the data described by the provided {@code targetDefinition} as a JSON
43 * value.
44 *
45 * @param targetDefinition
46 * the bound Module definition describing the structure of the JSON
47 * data to write
48 * @param targetObject
49 * the Java object data to write
50 * @param instances
51 * the set of named instances to write
52 * @throws IOException
53 * if an error occurred while writing the JSON
54 */
55 void writeDefinitionValue(
56 @NonNull IClassBinding targetDefinition,
57 @NonNull Object targetObject,
58 @NonNull Map<String, ? extends IBoundNamedInstance> instances) throws IOException;
59 }