001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.databind.codegen; 028 029import gov.nist.secauto.metaschema.core.model.IModule; 030import gov.nist.secauto.metaschema.core.util.CollectionUtil; 031import gov.nist.secauto.metaschema.databind.codegen.config.IBindingConfiguration; 032import gov.nist.secauto.metaschema.databind.codegen.typeinfo.ITypeResolver; 033 034import org.apache.logging.log4j.LogManager; 035import org.apache.logging.log4j.Logger; 036 037import java.io.IOException; 038import java.nio.file.Path; 039import java.util.Collection; 040import java.util.Objects; 041 042import edu.umd.cs.findbugs.annotations.NonNull; 043 044/** 045 * Provides methods for generating Java classes based on a single or a 046 * collection of Metaschemas. 047 */ 048public final class JavaGenerator { 049 private static final Logger LOGGER = LogManager.getLogger(JavaGenerator.class); 050 051 private JavaGenerator() { 052 // disable construction 053 } 054 055 /** 056 * Generate Java sources for the provided Metaschema module. 057 * 058 * @param module 059 * the Metaschema module to generate Java sources for 060 * @param targetDir 061 * the directory to generate sources in 062 * @param bindingConfiguration 063 * the binding customizations to use when generating the Java classes 064 * @return information about all the produced classes 065 * @throws IOException 066 * if an error occurred while generating the class 067 */ 068 public static IProduction generate( 069 @NonNull IModule module, 070 @NonNull Path targetDir, 071 @NonNull IBindingConfiguration bindingConfiguration) throws IOException { 072 return generate(CollectionUtil.singletonList(module), targetDir, bindingConfiguration); 073 } 074 075 /** 076 * Generates Java classes for Module fields and flags. 077 * 078 * @param modules 079 * the Metaschema modules to build classes for 080 * @param targetDirectory 081 * the directory to generate classes in 082 * @param bindingConfiguration 083 * binding customizations that can be used to set namespaces, class 084 * names, and other aspects of generated classes 085 * @return information about all the produced classes 086 * @throws IOException 087 * if a build error occurred while generating the class 088 */ 089 @NonNull 090 public static IProduction generate( 091 @NonNull Collection<? extends IModule> modules, 092 @NonNull Path targetDirectory, 093 @NonNull IBindingConfiguration bindingConfiguration) throws IOException { 094 Objects.requireNonNull(modules, "metaschemas"); 095 Objects.requireNonNull(targetDirectory, "generationTargetDirectory"); 096 Objects.requireNonNull(bindingConfiguration, "bindingConfiguration"); 097 if (LOGGER.isInfoEnabled()) { 098 LOGGER.info("Generating Java classes in: {}", targetDirectory); 099 } 100 101 ITypeResolver typeResolver = ITypeResolver.newTypeResolver(bindingConfiguration); 102 103 return IProduction.of(modules, typeResolver, targetDirectory); 104 } 105}