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.IFlagInstance; 035 036import java.util.Collection; 037 038import edu.umd.cs.findbugs.annotations.NonNull; 039import edu.umd.cs.findbugs.annotations.Nullable; 040 041public interface IModelDefinitionTypeInfo extends IDefinitionTypeInfo { 042 /** 043 * Construct a new type information object for the provided {@code definition}. 044 * 045 * @param definition 046 * the definition to provide type information for 047 * @param typeResolver 048 * use to resolve type information for composite instances 049 * @return the type information 050 */ 051 @NonNull 052 static IModelDefinitionTypeInfo newTypeInfo( 053 @NonNull IFlagContainer definition, 054 @NonNull ITypeResolver typeResolver) { 055 IModelDefinitionTypeInfo retval; 056 switch (definition.getModelType()) { 057 case ASSEMBLY: 058 retval = IAssemblyDefinitionTypeInfo.newTypeInfo((IAssemblyDefinition) definition, typeResolver); 059 break; 060 case FIELD: 061 retval = IFieldDefinitionTypeInfo.newTypeInfo((IFieldDefinition) definition, typeResolver); 062 break; 063 default: 064 throw new UnsupportedOperationException( 065 String.format("Generation of child classes for %s definitions is unsupported", 066 definition.getModelType().name())); 067 } 068 return retval; 069 } 070 071 @Override 072 IFlagContainer getDefinition(); 073 074 /** 075 * Get the class type information for the base class of the generated class, . 076 * 077 * @return the type information or {@code null} if no base class is configured 078 */ 079 @Nullable 080 ClassName getBaseClassName(); 081 082 /** 083 * Gets the class type information for the object definition for which this 084 * class is being generated. 085 * 086 * @return the class's type information 087 */ 088 @NonNull 089 ClassName getClassName(); 090 091 /** 092 * Get the type information for the provided {@code instance} value. 093 * 094 * @param instance 095 * the instance to get type information for 096 * @return the type information 097 */ 098 @Nullable 099 IFlagInstanceTypeInfo getFlagInstanceTypeInfo(@NonNull IFlagInstance instance); 100 101 /** 102 * Get the type information for all flag instance values on this definition. 103 * 104 * @return the type information 105 */ 106 @NonNull 107 Collection<IFlagInstanceTypeInfo> getFlagInstanceTypeInfos(); 108 // 109 // /** 110 // * Generates the associated Java class and saves it using the provided file. 111 // * 112 // * @param dir 113 // * the directory to generate the class in 114 // * @return the qualified class name for the generated class 115 // * @throws IOException 116 // * if a build error occurred while generating the class 117 // */ 118 // @NonNull 119 // IGeneratedDefinitionClass generateClass(@NonNull Path dir) throws 120 // IOException; 121 // 122 // /** 123 // * This method is responsible for generating the Java class using a builder 124 // that 125 // * is returned for further customization. 126 // * 127 // * @return the class definition for the generated class 128 // * @throws IOException 129 // * if a build error occurred while generating the class 130 // */ 131 // @NonNull 132 // TypeSpec generateChildClass() throws IOException; 133}