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.typeinfo; 028 029import com.squareup.javapoet.ClassName; 030 031import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition; 032import gov.nist.secauto.metaschema.core.model.IFieldDefinition; 033import gov.nist.secauto.metaschema.core.model.IFlagContainer; 034import gov.nist.secauto.metaschema.core.model.IModule; 035import gov.nist.secauto.metaschema.databind.codegen.config.IBindingConfiguration; 036 037import edu.umd.cs.findbugs.annotations.NonNull; 038import edu.umd.cs.findbugs.annotations.Nullable; 039 040public interface ITypeResolver { 041 /** 042 * Construct a new type resolver using the default implementation. 043 * 044 * @param bindingConfiguration 045 * the binding configuration used to configure types 046 * @return the type resolver 047 */ 048 @NonNull 049 static ITypeResolver newTypeResolver(@NonNull IBindingConfiguration bindingConfiguration) { 050 return new DefaultTypeResolver(bindingConfiguration); 051 } 052 053 /** 054 * Get type information for the provided {@code definition}. 055 * 056 * @param definition 057 * the definition to get type information for 058 * @return the type information 059 */ 060 @NonNull 061 IAssemblyDefinitionTypeInfo getTypeInfo(@NonNull IAssemblyDefinition definition); 062 063 /** 064 * Get type information for the provided {@code definition}. 065 * 066 * @param definition 067 * the definition to get type information for 068 * @return the type information 069 */ 070 @NonNull 071 IFieldDefinitionTypeInfo getTypeInfo(@NonNull IFieldDefinition definition); 072 073 /** 074 * Get type information for the provided {@code definition}. 075 * 076 * @param definition 077 * the definition to get type information for 078 * @return the type information 079 */ 080 @NonNull 081 IModelDefinitionTypeInfo getTypeInfo(@NonNull IFlagContainer definition); 082 083 /** 084 * Get the name of the class associated with the provided Module module. 085 * 086 * @param module 087 * the Module module that will be built as a class 088 * @return the class name information for the Module module 089 */ 090 @NonNull 091 ClassName getClassName(@NonNull IModule module); 092 093 /** 094 * Get the name of the class associated with the provided definition. 095 * 096 * @param definition 097 * a definition that may be built as a subclass 098 * @return the class name information for the definition 099 */ 100 @NonNull 101 ClassName getClassName(@NonNull IFlagContainer definition); 102 103 /** 104 * Get the name of the base class to use for the class associated with the 105 * provided definition. 106 * 107 * @param definition 108 * a definition that may be built as a class 109 * @return the name of the base class or {@code null} if no base class is to be 110 * used 111 */ 112 @Nullable 113 ClassName getBaseClassName(@NonNull IFlagContainer definition); 114 115 /** 116 * Get the Java package name to use for the provided Module module. 117 * 118 * @param module 119 * the Module module 120 * @return the Java package name 121 */ 122 @NonNull 123 String getPackageName(@NonNull IModule module); 124}