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.schemagen.json.schema;
28
29 import com.fasterxml.jackson.databind.node.ObjectNode;
30
31 import gov.nist.secauto.metaschema.schemagen.SchemaGenerationException;
32 import gov.nist.secauto.metaschema.schemagen.json.impl.JsonGenerationState;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35
36 /**
37 * A JSON schema construct, which may be a sub-schema.
38 */
39 public interface IJsonSchema {
40 // /**
41 // * Determine if the type is generated by the schema generator.
42 // * <p>
43 // * Built-in types are not generated by the schema generator.
44 // *
45 // * @param state
46 // * the schema generation state used for context
47 // * @return {@code true} if the type is generated by the schema generator or
48 // {@code false}
49 // otherwise
50 // */
51 // boolean isGenerated(@NonNull JsonGenerationState state);
52
53 boolean isInline(@NonNull JsonGenerationState state);
54
55 /**
56 * Generate the schema type.
57 *
58 * @param state
59 * the schema generation state used for context and writing
60 * @param obj
61 * the parent JSON object to populate
62 * @throws SchemaGenerationException
63 * if an error occurred while writing the type
64 */
65 void generateSchema(@NonNull JsonGenerationState state, @NonNull ObjectNode obj);
66
67 default void generateSchemaOrRef(@NonNull JsonGenerationState state, @NonNull ObjectNode obj) {
68 // by default generate the schema
69 generateSchema(state, obj);
70 }
71
72 void resolveSubSchemas(@NonNull JsonGenerationState state);
73 }