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.typeinfo;
28
29 import gov.nist.secauto.metaschema.core.model.IDefinition;
30 import gov.nist.secauto.metaschema.core.model.INamedInstance;
31
32 import java.util.Collection;
33
34 import edu.umd.cs.findbugs.annotations.NonNull;
35 import edu.umd.cs.findbugs.annotations.Nullable;
36
37 public interface IDefinitionTypeInfo {
38 /**
39 * Get the definition associated with this type info.
40 *
41 * @return the definition
42 */
43 @NonNull
44 IDefinition getDefinition();
45
46 /**
47 * Gets the resolver which can be used to lookup Java type information for
48 * Module objects.
49 *
50 * @return the type resolver
51 */
52 @NonNull
53 ITypeResolver getTypeResolver();
54
55 /**
56 * Check's if the Java class to be generated will have a property with the given
57 * name.
58 *
59 * @param propertyName
60 * the property name to look for
61 * @return {@code true} if there is an associated property with the name or
62 * {@code false} otherwise
63 */
64 boolean hasPropertyWithName(@NonNull String propertyName);
65
66 /**
67 * Get the type information for the provided {@code instance} value.
68 *
69 * @param instance
70 * the instance to get type information for
71 * @return the type information
72 */
73 @Nullable
74 IInstanceTypeInfo getInstanceTypeInfo(@NonNull INamedInstance instance);
75
76 /**
77 * Get the type information for all instance values on this definition.
78 *
79 * @return the type information
80 */
81 @NonNull
82 Collection<IInstanceTypeInfo> getInstanceTypeInfos();
83
84 /**
85 * Get the type information for all Java class properties associated with a
86 * given instance.
87 *
88 * @return the type information
89 */
90 @NonNull
91 Collection<ITypeInfo> getPropertyTypeInfos();
92 }