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.codegen.typeinfo;
28
29 import com.squareup.javapoet.ClassName;
30
31 import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
32 import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
33 import gov.nist.secauto.metaschema.core.model.IFlagContainer;
34 import gov.nist.secauto.metaschema.core.model.IFlagInstance;
35
36 import java.util.Collection;
37
38 import edu.umd.cs.findbugs.annotations.NonNull;
39 import edu.umd.cs.findbugs.annotations.Nullable;
40
41 public interface IModelDefinitionTypeInfo extends IDefinitionTypeInfo {
42 /**
43 * Construct a new type information object for the provided {@code definition}.
44 *
45 * @param definition
46 * the definition to provide type information for
47 * @param typeResolver
48 * use to resolve type information for composite instances
49 * @return the type information
50 */
51 @NonNull
52 static IModelDefinitionTypeInfo newTypeInfo(
53 @NonNull IFlagContainer definition,
54 @NonNull ITypeResolver typeResolver) {
55 IModelDefinitionTypeInfo retval;
56 switch (definition.getModelType()) {
57 case ASSEMBLY:
58 retval = IAssemblyDefinitionTypeInfo.newTypeInfo((IAssemblyDefinition) definition, typeResolver);
59 break;
60 case FIELD:
61 retval = IFieldDefinitionTypeInfo.newTypeInfo((IFieldDefinition) definition, typeResolver);
62 break;
63 default:
64 throw new UnsupportedOperationException(
65 String.format("Generation of child classes for %s definitions is unsupported",
66 definition.getModelType().name()));
67 }
68 return retval;
69 }
70
71 @Override
72 IFlagContainer getDefinition();
73
74 /**
75 * Get the class type information for the base class of the generated class, .
76 *
77 * @return the type information or {@code null} if no base class is configured
78 */
79 @Nullable
80 ClassName getBaseClassName();
81
82 /**
83 * Gets the class type information for the object definition for which this
84 * class is being generated.
85 *
86 * @return the class's type information
87 */
88 @NonNull
89 ClassName getClassName();
90
91 /**
92 * Get the type information for the provided {@code instance} value.
93 *
94 * @param instance
95 * the instance to get type information for
96 * @return the type information
97 */
98 @Nullable
99 IFlagInstanceTypeInfo getFlagInstanceTypeInfo(@NonNull IFlagInstance instance);
100
101 /**
102 * Get the type information for all flag instance values on this definition.
103 *
104 * @return the type information
105 */
106 @NonNull
107 Collection<IFlagInstanceTypeInfo> getFlagInstanceTypeInfos();
108 //
109 // /**
110 // * Generates the associated Java class and saves it using the provided file.
111 // *
112 // * @param dir
113 // * the directory to generate the class in
114 // * @return the qualified class name for the generated class
115 // * @throws IOException
116 // * if a build error occurred while generating the class
117 // */
118 // @NonNull
119 // IGeneratedDefinitionClass generateClass(@NonNull Path dir) throws
120 // IOException;
121 //
122 // /**
123 // * This method is responsible for generating the Java class using a builder
124 // that
125 // * is returned for further customization.
126 // *
127 // * @return the class definition for the generated class
128 // * @throws IOException
129 // * if a build error occurred while generating the class
130 // */
131 // @NonNull
132 // TypeSpec generateChildClass() throws IOException;
133 }