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 com.squareup.javapoet.TypeName;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32
33 public interface ITypeInfo {
34
35 /**
36 * Get the name to use for the property. If the property is a collection type,
37 * then this will be the group-as name, else this will be the use name or the
38 * name if not use name is set.
39 *
40 * @return the name
41 */
42 @NonNull
43 String getBaseName();
44
45 /**
46 * The name to use for Java constructs that refer to the item. This is used for
47 * when a field is collection-based and there is a need to refer to a single
48 * item, such as in an add/remove method name.
49 *
50 * @return the item base name
51 */
52 @NonNull
53 default String getItemBaseName() {
54 return getBaseName();
55 }
56
57 /**
58 * Get the Java property name for the property.
59 *
60 * @return the Java property name
61 */
62 @NonNull
63 String getPropertyName();
64
65 /**
66 * Gets the name of the Java field for this property.
67 *
68 * @return the Java field name
69 */
70 @NonNull
71 String getJavaFieldName();
72
73 /**
74 * Gets the type of the associated Java field for the property.
75 *
76 * @return the Java type for the field
77 */
78 @NonNull
79 TypeName getJavaFieldType();
80
81 /**
82 * Gets the type of the property's item.
83 *
84 * @return the Java type for the item
85 */
86 @NonNull
87 default TypeName getJavaItemType() {
88 return getJavaFieldType();
89 }
90 }