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;
28
29 import gov.nist.secauto.metaschema.core.model.IModule;
30 import gov.nist.secauto.metaschema.databind.model.IClassBinding;
31 import gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaAssembly;
32 import gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaField;
33
34 import java.util.Map;
35
36 import edu.umd.cs.findbugs.annotations.NonNull;
37 import edu.umd.cs.findbugs.annotations.Nullable;
38
39 interface IModuleLoaderStrategy {
40 /**
41 * Get the Metaschema module identified by the provided class.
42 *
43 * @param clazz
44 * the Module class
45 * @return the module
46 * @throws IllegalStateException
47 * if an error occurred while processing the associated module
48 * information
49 */
50 @NonNull
51 IModule getModuleByClass(@NonNull Class<? extends IModule> clazz);
52
53 /**
54 * Get the {@link IClassBinding} instance for a {@link MetaschemaAssembly} or
55 * {@link MetaschemaField} associated with a Java class.
56 *
57 * @param clazz
58 * the class binding to load
59 * @return the associated class binding instance or {@code null} if the class is
60 * not bound
61 */
62 @Nullable
63 IClassBinding getClassBinding(@NonNull Class<?> clazz);
64
65 @NonNull
66 Map<Class<?>, IClassBinding> getClassBindingsByClass();
67 }