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.core.util.CollectionUtil;
31 import gov.nist.secauto.metaschema.databind.codegen.config.IBindingConfiguration;
32 import gov.nist.secauto.metaschema.databind.codegen.typeinfo.ITypeResolver;
33
34 import org.apache.logging.log4j.LogManager;
35 import org.apache.logging.log4j.Logger;
36
37 import java.io.IOException;
38 import java.nio.file.Path;
39 import java.util.Collection;
40 import java.util.Objects;
41
42 import edu.umd.cs.findbugs.annotations.NonNull;
43
44 /**
45 * Provides methods for generating Java classes based on a single or a
46 * collection of Metaschemas.
47 */
48 public final class JavaGenerator {
49 private static final Logger LOGGER = LogManager.getLogger(JavaGenerator.class);
50
51 private JavaGenerator() {
52 // disable construction
53 }
54
55 /**
56 * Generate Java sources for the provided Metaschema module.
57 *
58 * @param module
59 * the Metaschema module to generate Java sources for
60 * @param targetDir
61 * the directory to generate sources in
62 * @param bindingConfiguration
63 * the binding customizations to use when generating the Java classes
64 * @return information about all the produced classes
65 * @throws IOException
66 * if an error occurred while generating the class
67 */
68 public static IProduction generate(
69 @NonNull IModule module,
70 @NonNull Path targetDir,
71 @NonNull IBindingConfiguration bindingConfiguration) throws IOException {
72 return generate(CollectionUtil.singletonList(module), targetDir, bindingConfiguration);
73 }
74
75 /**
76 * Generates Java classes for Module fields and flags.
77 *
78 * @param modules
79 * the Metaschema modules to build classes for
80 * @param targetDirectory
81 * the directory to generate classes in
82 * @param bindingConfiguration
83 * binding customizations that can be used to set namespaces, class
84 * names, and other aspects of generated classes
85 * @return information about all the produced classes
86 * @throws IOException
87 * if a build error occurred while generating the class
88 */
89 @NonNull
90 public static IProduction generate(
91 @NonNull Collection<? extends IModule> modules,
92 @NonNull Path targetDirectory,
93 @NonNull IBindingConfiguration bindingConfiguration) throws IOException {
94 Objects.requireNonNull(modules, "metaschemas");
95 Objects.requireNonNull(targetDirectory, "generationTargetDirectory");
96 Objects.requireNonNull(bindingConfiguration, "bindingConfiguration");
97 if (LOGGER.isInfoEnabled()) {
98 LOGGER.info("Generating Java classes in: {}", targetDirectory);
99 }
100
101 ITypeResolver typeResolver = ITypeResolver.newTypeResolver(bindingConfiguration);
102
103 return IProduction.of(modules, typeResolver, targetDirectory);
104 }
105 }