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;
28
29 import gov.nist.secauto.metaschema.core.model.IModule;
30 import gov.nist.secauto.metaschema.databind.codegen.typeinfo.IModelDefinitionTypeInfo;
31 import gov.nist.secauto.metaschema.databind.codegen.typeinfo.ITypeResolver;
32
33 import java.io.IOException;
34 import java.net.URI;
35 import java.nio.file.Path;
36 import java.util.Collection;
37
38 import edu.umd.cs.findbugs.annotations.NonNull;
39
40 public interface IMetaschemaClassFactory {
41 /**
42 * Get a new instance of the default class generation factory that uses the
43 * provided {@code typeResolver}.
44 *
45 * @param typeResolver
46 * the resolver used to generate type information for Metasschema
47 * constructs
48 * @return the new class factory
49 */
50 @NonNull
51 static IMetaschemaClassFactory newInstance(@NonNull ITypeResolver typeResolver) {
52 return DefaultMetaschemaClassFactory.newInstance(typeResolver);
53 }
54
55 /**
56 * Get the type resolver used to generate type information for Metasschema
57 * constructs represented as Java classes, fields, and methods.
58 *
59 * @return the type resolver
60 */
61 @NonNull
62 ITypeResolver getTypeResolver();
63
64 /**
65 * Generate a class in the provided {@code targetDirectory} that represents the
66 * provided Module {@code module}.
67 *
68 * @param module
69 * the Module module to generate the class for
70 * @param targetDirectory
71 * the directory to generate the Java class in
72 * @return information about the generated class
73 * @throws IOException
74 * if an error occurred while generating the Java class
75 */
76 @NonNull
77 IGeneratedModuleClass generateClass(
78 @NonNull IModule module,
79 @NonNull Path targetDirectory) throws IOException;
80
81 /**
82 * Generate a class in the provided {@code targetDirectory} that represents the
83 * provided Module definition's {@code typeInfo}.
84 *
85 * @param typeInfo
86 * the type information for the class to generate
87 * @param targetDirectory
88 * the directory to generate the Java class in
89 * @return the generated class details
90 * @throws IOException
91 * if an error occurred while generating the Java class
92 */
93 @NonNull
94 IGeneratedDefinitionClass generateClass(
95 @NonNull IModelDefinitionTypeInfo typeInfo,
96 @NonNull Path targetDirectory) throws IOException;
97
98 /**
99 * Generate a package-info.java class in the provided {@code targetDirectory}
100 * that represents a collection of Module modules.
101 *
102 * @param javaPackage
103 * the Java package name to use
104 * @param xmlNamespace
105 * the default XML namespace for all bound Module information elements
106 * in the generated package
107 * @param metaschemaProductions
108 * a collection of previously generated Module modules and definition
109 * classes
110 * @param targetDirectory
111 * the directory to generate the Java class in
112 * @return the generated class details
113 * @throws IOException
114 * if an error occurred while generating the Java class
115 */
116 @NonNull
117 IGeneratedClass generatePackageInfoClass(
118 @NonNull String javaPackage,
119 @NonNull URI xmlNamespace,
120 @NonNull Collection<IGeneratedModuleClass> metaschemaProductions,
121 @NonNull Path targetDirectory) throws IOException;
122 }