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.config;
28
29 import gov.nist.secauto.metaschema.core.model.IFlagContainer;
30 import gov.nist.secauto.metaschema.core.model.IModule;
31
32 import edu.umd.cs.findbugs.annotations.NonNull;
33 import edu.umd.cs.findbugs.annotations.Nullable;
34
35 public interface IBindingConfiguration {
36
37 /**
38 * Generates a Java package name for the provided Module module.
39 *
40 * @param module
41 * the Module module to generate a package name for
42 * @return a Java package name
43 */
44 @NonNull
45 String getPackageNameForModule(@NonNull IModule module);
46
47 /**
48 * Get the Java class name for the provided field or assembly definition.
49 *
50 * @param definition
51 * the definition to generate the Java class name for
52 * @return a Java class name
53 */
54 @NonNull
55 String getClassName(@NonNull IFlagContainer definition);
56
57 /**
58 * Get the Java class name for the provided Module module.
59 *
60 * @param module
61 * the Module module to generate the Java class name for
62 * @return a Java class name
63 */
64 @NonNull
65 String getClassName(@NonNull IModule module);
66
67 /**
68 * Get the Java class name of the base class to use for the class associated
69 * with the provided definition.
70 *
71 * @param definition
72 * a definition that may be built as a class
73 * @return the name of the base class or {@code null} if no base class is to be
74 * used
75 */
76 @Nullable
77 String getQualifiedBaseClassName(@NonNull IFlagContainer definition);
78 }