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.config;
028
029import gov.nist.secauto.metaschema.core.model.IFlagContainer;
030import gov.nist.secauto.metaschema.core.model.IModule;
031
032import edu.umd.cs.findbugs.annotations.NonNull;
033import edu.umd.cs.findbugs.annotations.Nullable;
034
035public interface IBindingConfiguration {
036
037  /**
038   * Generates a Java package name for the provided Module module.
039   *
040   * @param module
041   *          the Module module to generate a package name for
042   * @return a Java package name
043   */
044  @NonNull
045  String getPackageNameForModule(@NonNull IModule module);
046
047  /**
048   * Get the Java class name for the provided field or assembly definition.
049   *
050   * @param definition
051   *          the definition to generate the Java class name for
052   * @return a Java class name
053   */
054  @NonNull
055  String getClassName(@NonNull IFlagContainer definition);
056
057  /**
058   * Get the Java class name for the provided Module module.
059   *
060   * @param module
061   *          the Module module to generate the Java class name for
062   * @return a Java class name
063   */
064  @NonNull
065  String getClassName(@NonNull IModule module);
066
067  /**
068   * Get the Java class name of the base class to use for the class associated
069   * with the provided definition.
070   *
071   * @param definition
072   *          a definition that may be built as a class
073   * @return the name of the base class or {@code null} if no base class is to be
074   *         used
075   */
076  @Nullable
077  String getQualifiedBaseClassName(@NonNull IFlagContainer definition);
078}