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.databind.codegen.typeinfo.IModelDefinitionTypeInfo;
031import gov.nist.secauto.metaschema.databind.codegen.typeinfo.ITypeResolver;
032
033import java.io.IOException;
034import java.net.URI;
035import java.nio.file.Path;
036import java.util.Collection;
037
038import edu.umd.cs.findbugs.annotations.NonNull;
039
040public interface IMetaschemaClassFactory {
041  /**
042   * Get a new instance of the default class generation factory that uses the
043   * provided {@code typeResolver}.
044   *
045   * @param typeResolver
046   *          the resolver used to generate type information for Metasschema
047   *          constructs
048   * @return the new class factory
049   */
050  @NonNull
051  static IMetaschemaClassFactory newInstance(@NonNull ITypeResolver typeResolver) {
052    return DefaultMetaschemaClassFactory.newInstance(typeResolver);
053  }
054
055  /**
056   * Get the type resolver used to generate type information for Metasschema
057   * constructs represented as Java classes, fields, and methods.
058   *
059   * @return the type resolver
060   */
061  @NonNull
062  ITypeResolver getTypeResolver();
063
064  /**
065   * Generate a class in the provided {@code targetDirectory} that represents the
066   * provided Module {@code module}.
067   *
068   * @param module
069   *          the Module module to generate the class for
070   * @param targetDirectory
071   *          the directory to generate the Java class in
072   * @return information about the generated class
073   * @throws IOException
074   *           if an error occurred while generating the Java class
075   */
076  @NonNull
077  IGeneratedModuleClass generateClass(
078      @NonNull IModule module,
079      @NonNull Path targetDirectory) throws IOException;
080
081  /**
082   * Generate a class in the provided {@code targetDirectory} that represents the
083   * provided Module definition's {@code typeInfo}.
084   *
085   * @param typeInfo
086   *          the type information for the class to generate
087   * @param targetDirectory
088   *          the directory to generate the Java class in
089   * @return the generated class details
090   * @throws IOException
091   *           if an error occurred while generating the Java class
092   */
093  @NonNull
094  IGeneratedDefinitionClass generateClass(
095      @NonNull IModelDefinitionTypeInfo typeInfo,
096      @NonNull Path targetDirectory) throws IOException;
097
098  /**
099   * 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}