improve annotation abstraction

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/Framework.kt

@@ -1,17 +1,6 @@
 /*
- * Copyright 2020 the original authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
  */
 
 package io.openapiprocessor.core.framework

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/FrameworkAnnotation.kt

@@ -1,28 +1,16 @@
 /*
- * Copyright 2020 the original authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
  */
 
 package io.openapiprocessor.core.framework
 
 import io.openapiprocessor.core.model.parameters.Parameter
 import io.openapiprocessor.core.parser.HttpMethod
+import io.openapiprocessor.core.model.Annotation
 
 /**
  * provides annotation details of the framework.
- *
- * @author Martin Hauner
  */
 interface FrameworkAnnotations {
 
@@ -32,14 +20,14 @@ interface FrameworkAnnotations {
      * @param httpMethod requested http method
      * @return annotation details
      */
-    fun getAnnotation(httpMethod: HttpMethod): FrameworkAnnotation
+    fun getAnnotation(httpMethod: HttpMethod): Annotation
 
     /**
      * provides the details of the requested method parameter annotation.
      *
      * @param parameter requested parameter
      * @return annotation details
      */
-    fun getAnnotation(parameter: Parameter): FrameworkAnnotation
+    fun getAnnotation(parameter: Parameter): Annotation
 
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/FrameworkAnnotations.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.model
+
+import io.openapiprocessor.core.converter.mapping.ParameterValue
+
+open class Annotation(
+    private val canonicalName: String,
+    val parameters: LinkedHashMap<String, ParameterValue> = linkedMapOf()
+) {
+    val typeName: String
+        get() {
+            return canonicalName.substring(canonicalName.lastIndexOf('.') + 1)
+        }
+
+    val packageName: String
+        get() {
+            return canonicalName.substring(0, canonicalName.lastIndexOf('.') + 1)
+        }
+
+    val imports = setOf(canonicalName)
+
+    val referencedImports: Set<String>
+        get() {
+            return parameters
+                .values.mapNotNull { it.import }
+                .toSet()
+        }
+
+    /**
+     * The full annotation name with a leading @.
+     */
+    val annotationName: String
+        get() = "@${typeName}"
+}

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/Annotation.kt

@@ -3,8 +3,9 @@
  * PDX-License-Identifier: Apache-2.0
  */
 
-package io.openapiprocessor.core.writer.java;
+package io.openapiprocessor.core.writer.java
 
+import io.openapiprocessor.core.model.Annotation
 import java.io.StringWriter
 import java.io.Writer
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/Annotation.kt

@@ -7,6 +7,7 @@ package io.openapiprocessor.core.writer.java
 
 import io.openapiprocessor.core.converter.mapping.ParameterValue
 import io.openapiprocessor.core.converter.mapping.SimpleParameterValue
+import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.datatypes.*
 import org.apache.commons.text.StringEscapeUtils.escapeJava
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/AnnotationWriter.kt

@@ -5,6 +5,7 @@
 
 package io.openapiprocessor.core.writer.java
 
+import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.datatypes.*
 
 data class BeanValidationValue(
@@ -40,7 +41,7 @@ class BeanValidationInfoSimple(
         )
 
     private val annotationImports: Set<String>
-        get() = annotations.map { it.import }.toSet()
+        get() = annotations.map { it.imports }.flatten().toSet()
 
     private val annotationValues: List<String>
         get() = annotations.map { buildAnnotation(it) }.toList()
@@ -147,13 +148,13 @@ class BeanValidationInfoCollection(
         }
 
     private val annotationImports: Set<String>
-        get() = annotations.map { it.import }.toSet()
+        get() = annotations.map { it.imports }.flatten().toSet()
 
     private val annotationValues: List<String>
         get() = annotations.map { buildAnnotation(it) }.toList()
 
     private val itemAnnotationImports: Set<String>
-        get() = item.annotations.map { it.import }.toSet()
+        get() = item.annotations.map { it.imports }.flatten().toSet()
 
     private val itemAnnotationValues: List<String>
         get() = item.annotations.map { buildAnnotation(it) }.toList()

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/BeanValidationFactory.kt

@@ -7,6 +7,7 @@ package io.openapiprocessor.core.writer.java
 
 import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.converter.MappingFinder
+import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.datatypes.DataType
 import io.openapiprocessor.core.model.datatypes.ModelDataType
 import io.openapiprocessor.core.model.datatypes.ObjectDataType

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/BeanValidationInfo.kt

@@ -56,7 +56,7 @@ class InterfaceWriter(
         imports.add(generatedWriter.getImport())
 
         endpoints.forEach { ep ->
-            imports.add(annotations.getAnnotation (ep.method).fullyQualifiedName)
+            imports.addAll(annotations.getAnnotation (ep.method).imports)
 
             if (ep.deprecated) {
                 imports.add (java.lang.Deprecated::class.java.canonicalName)
@@ -87,7 +87,7 @@ class InterfaceWriter(
         }
 
         if (parameter.withAnnotation) {
-            imports.add(annotations.getAnnotation(parameter).fullyQualifiedName)
+            imports.addAll(annotations.getAnnotation(parameter).imports)
         }
 
         if (parameter is AdditionalParameter && parameter.annotationDataType != null) {