From 2672dff51203a4d07165a32c6c1132e3a75df1ef Mon Sep 17 00:00:00 2001 From: Robin Bygrave Date: Wed, 10 Feb 2021 15:28:55 +1300 Subject: [PATCH] #2155 - QueryBeans: Change to use own @Generated with retention RUNTIME --- .../java/io/ebean/typequery/Generated.java | 22 ++++++++++++++++++ .../ebean/querybean/generator/Constants.java | 5 +--- .../generator/ProcessingContext.java | 19 --------------- .../generator/SimpleModuleInfoWriter.java | 9 ++------ .../generator/SimpleQueryBeanWriter.java | 14 +++-------- .../ebean/querybean/generator/Constants.java | 6 ++--- .../generator/ProcessingContext.java | 23 ------------------- .../generator/SimpleModuleInfoWriter.java | 9 ++------ .../generator/SimpleQueryBeanWriter.java | 13 +++-------- 9 files changed, 35 insertions(+), 85 deletions(-) create mode 100644 ebean-querybean/src/main/java/io/ebean/typequery/Generated.java diff --git a/ebean-querybean/src/main/java/io/ebean/typequery/Generated.java b/ebean-querybean/src/main/java/io/ebean/typequery/Generated.java new file mode 100644 index 000000000..918e0d1b4 --- /dev/null +++ b/ebean-querybean/src/main/java/io/ebean/typequery/Generated.java @@ -0,0 +1,22 @@ +package io.ebean.typequery; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marks generated query bean source code. + *

+ * This is code generated by the query bean generator (annotation processor). + */ +@Target({ ElementType.TYPE }) +@Retention(RetentionPolicy.RUNTIME) +public @interface Generated { + + /** + * The name of the generator used to generate this source. + */ + String value(); + +} diff --git a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java index 79827d405..e0431f9b0 100644 --- a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java +++ b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java @@ -3,11 +3,8 @@ package io.ebean.querybean.generator; interface Constants { String AT_GENERATED = "@Generated(\"io.ebean.querybean.kotlin-generator\")"; - String AT_TYPEQUERYBEAN = "@TypeQueryBean(\"v1\")"; - - String GENERATED_9 = "javax.annotation.processing.Generated"; - String GENERATED_8 = "javax.annotation.Generated"; + String GENERATED = "io.ebean.typequery.Generated"; String MAPPED_SUPERCLASS = "javax.persistence.MappedSuperclass"; String INHERITANCE = "javax.persistence.Inheritance"; diff --git a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java index b01075a53..d08242ef4 100644 --- a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java +++ b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java @@ -50,7 +50,6 @@ class ProcessingContext implements Constants { private final Filer filer; private final Messager messager; private final Elements elementUtils; - private final String generatedAnnotation; private final PropertyTypeMap propertyTypeMap = new PropertyTypeMap(); @@ -99,9 +98,6 @@ class ProcessingContext implements Constants { this.filer = processingEnv.getFiler(); this.messager = processingEnv.getMessager(); this.elementUtils = processingEnv.getElementUtils(); - - boolean jdk8 = processingEnv.getSourceVersion().compareTo(SourceVersion.RELEASE_8) <= 0; - this.generatedAnnotation = generatedAnnotation(jdk8); this.generatedSources = initGeneratedSources(processingEnv); this.readModuleInfo = new ReadModuleInfo(this); } @@ -122,13 +118,6 @@ class ProcessingContext implements Constants { return elementUtils.getTypeElement(EBEAN_COMPONENT); } - private String generatedAnnotation(boolean jdk8) { - if (jdk8) { - return isTypeAvailable(GENERATED_8) ? GENERATED_8 : null; - } - return isTypeAvailable(GENERATED_9) ? GENERATED_9 : null; - } - private String initGeneratedSources(ProcessingEnvironment processingEnv) { String generatedDir = processingEnv.getOptions().get("kapt.kotlin.generated"); return (generatedDir != null) ? generatedDir : "target/generated-sources/kapt/compile"; @@ -430,14 +419,6 @@ class ProcessingContext implements Constants { messager.printMessage(Diagnostic.Kind.NOTE, String.format(msg, args)); } - boolean isGeneratedAvailable() { - return generatedAnnotation != null; - } - - String getGeneratedAnnotation() { - return generatedAnnotation; - } - void readModuleInfo() { String factory = loadMetaInfServices(); if (factory != null) { diff --git a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java index a8f734968..926aad8ae 100644 --- a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java +++ b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java @@ -90,10 +90,7 @@ class SimpleModuleInfoWriter { writer.append("import java.util.ArrayList;").eol(); writer.append("import java.util.Collections;").eol(); writer.append("import java.util.List;").eol(); - final String generated = processingContext.getGeneratedAnnotation(); - if (generated != null) { - writer.append("import %s;", generated).eol(); - } + writer.append("import %s;", Constants.GENERATED).eol(); writer.eol(); writer.append("import io.ebean.config.ModuleInfo;").eol(); writer.append("import io.ebean.config.ModuleInfoLoader;").eol(); @@ -102,9 +99,7 @@ class SimpleModuleInfoWriter { } void buildAtContextModule(Append writer) { - if (processingContext.isGeneratedAvailable()) { - writer.append(Constants.AT_GENERATED).eol(); - } + writer.append(Constants.AT_GENERATED).eol(); writer.append("@ModuleInfo("); if (processingContext.hasOtherClasses()) { writer.append("other={%s}, ", otherClasses()); diff --git a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java index 7c5fb4ba8..8524a59f9 100644 --- a/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java +++ b/kotlin-querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java @@ -88,11 +88,7 @@ class SimpleQueryBeanWriter { } private void gatherPropertyDetails() { - - final String generated = processingContext.getGeneratedAnnotation(); - if (generated != null) { - importTypes.add(generated); - } + importTypes.add(Constants.GENERATED); importTypes.add(beanFullName); importTypes.add(Constants.TQROOTBEAN); importTypes.add(Constants.TYPEQUERYBEAN); @@ -282,9 +278,7 @@ class SimpleQueryBeanWriter { writer.append(" * ").eol(); writer.append(" * THIS IS A GENERATED OBJECT, DO NOT MODIFY THIS CLASS.").eol(); writer.append(" */").eol(); - if (processingContext.isGeneratedAvailable()) { - writer.append(Constants.AT_GENERATED).eol(); - } + writer.append(Constants.AT_GENERATED).eol(); writer.append(Constants.AT_TYPEQUERYBEAN).eol(); lang().beginAssocClass(writer, shortName, origShortName); @@ -294,9 +288,7 @@ class SimpleQueryBeanWriter { writer.append(" * ").eol(); writer.append(" * THIS IS A GENERATED OBJECT, DO NOT MODIFY THIS CLASS.").eol(); writer.append(" */").eol(); - if (processingContext.isGeneratedAvailable()) { - writer.append(Constants.AT_GENERATED).eol(); - } + writer.append(Constants.AT_GENERATED).eol(); writer.append(Constants.AT_TYPEQUERYBEAN).eol(); lang().beginClass(writer, shortName); } diff --git a/querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java b/querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java index 959c08721..2b27a034c 100644 --- a/querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java +++ b/querybean-generator/src/main/java/io/ebean/querybean/generator/Constants.java @@ -5,9 +5,7 @@ interface Constants { String AT_GENERATED = "@Generated(\"io.ebean.querybean.generator\")"; String AT_TYPEQUERYBEAN = "@TypeQueryBean(\"v1\")"; - - String GENERATED_9 = "javax.annotation.processing.Generated"; - String GENERATED_8 = "javax.annotation.Generated"; + String GENERATED = "io.ebean.typequery.Generated"; String MAPPED_SUPERCLASS = "javax.persistence.MappedSuperclass"; String INHERITANCE = "javax.persistence.Inheritance"; @@ -35,4 +33,4 @@ interface Constants { String METAINF_MANIFEST = "META-INF/ebean-generated-info.mf"; String METAINF_SERVICES_MODULELOADER = "META-INF/services/io.ebean.config.ModuleInfoLoader"; -} \ No newline at end of file +} diff --git a/querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java b/querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java index 6eae281b6..fe73814e2 100644 --- a/querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java +++ b/querybean-generator/src/main/java/io/ebean/querybean/generator/ProcessingContext.java @@ -46,7 +46,6 @@ class ProcessingContext implements Constants { private final Filer filer; private final Messager messager; private final Elements elementUtils; - private final String generatedAnnotation; private final PropertyTypeMap propertyTypeMap = new PropertyTypeMap(); @@ -95,9 +94,6 @@ class ProcessingContext implements Constants { this.filer = processingEnv.getFiler(); this.messager = processingEnv.getMessager(); this.elementUtils = processingEnv.getElementUtils(); - - boolean jdk8 = processingEnv.getSourceVersion().compareTo(SourceVersion.RELEASE_8) <= 0; - this.generatedAnnotation = generatedAnnotation(jdk8); this.readModuleInfo = new ReadModuleInfo(this); } @@ -117,17 +113,6 @@ class ProcessingContext implements Constants { return elementUtils.getTypeElement(EBEAN_COMPONENT); } - private String generatedAnnotation(boolean jdk8) { - if (jdk8) { - return isTypeAvailable(GENERATED_8) ? GENERATED_8 : null; - } - return isTypeAvailable(GENERATED_9) ? GENERATED_9 : null; - } - - private boolean isTypeAvailable(String canonicalName) { - return null != elementUtils.getTypeElement(canonicalName); - } - /** * Gather all the fields (properties) for the given bean element. */ @@ -413,14 +398,6 @@ class ProcessingContext implements Constants { messager.printMessage(Diagnostic.Kind.NOTE, String.format(msg, args)); } - boolean isGeneratedAvailable() { - return generatedAnnotation != null; - } - - String getGeneratedAnnotation() { - return generatedAnnotation; - } - void readModuleInfo() { String factory = loadMetaInfServices(); if (factory != null) { diff --git a/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java b/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java index c48896a50..b9c1b606e 100644 --- a/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java +++ b/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleModuleInfoWriter.java @@ -89,10 +89,7 @@ class SimpleModuleInfoWriter { writer.append("import java.util.ArrayList;").eol(); writer.append("import java.util.Collections;").eol(); writer.append("import java.util.List;").eol(); - final String generated = processingContext.getGeneratedAnnotation(); - if (generated != null) { - writer.append("import %s;", generated).eol(); - } + writer.append("import %s;", Constants.GENERATED).eol(); writer.eol(); writer.append("import io.ebean.config.ModuleInfo;").eol(); writer.append("import io.ebean.config.ModuleInfoLoader;").eol(); @@ -100,9 +97,7 @@ class SimpleModuleInfoWriter { } void buildAtContextModule(Append writer) { - if (processingContext.isGeneratedAvailable()) { - writer.append(Constants.AT_GENERATED).eol(); - } + writer.append(Constants.AT_GENERATED).eol(); writer.append("@ModuleInfo("); if (processingContext.hasOtherClasses()) { writer.append("other={%s}, ", otherClasses()); diff --git a/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java b/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java index a54ddc840..78fd99779 100644 --- a/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java +++ b/querybean-generator/src/main/java/io/ebean/querybean/generator/SimpleQueryBeanWriter.java @@ -62,10 +62,7 @@ class SimpleQueryBeanWriter { } private void gatherPropertyDetails() { - final String generated = processingContext.getGeneratedAnnotation(); - if (generated != null) { - importTypes.add(generated); - } + importTypes.add(Constants.GENERATED); importTypes.add(beanFullName); importTypes.add(Constants.TQROOTBEAN); importTypes.add(Constants.TYPEQUERYBEAN); @@ -301,9 +298,7 @@ class SimpleQueryBeanWriter { writer.append(" * ").eol(); writer.append(" * THIS IS A GENERATED OBJECT, DO NOT MODIFY THIS CLASS.").eol(); writer.append(" */").eol(); - if (processingContext.isGeneratedAvailable()) { - writer.append(Constants.AT_GENERATED).eol(); - } + writer.append(Constants.AT_GENERATED).eol(); writer.append(Constants.AT_TYPEQUERYBEAN).eol(); writer.append("public class Q%s extends TQAssocBean<%s,R> {", shortName, origShortName).eol(); @@ -313,9 +308,7 @@ class SimpleQueryBeanWriter { writer.append(" * ").eol(); writer.append(" * THIS IS A GENERATED OBJECT, DO NOT MODIFY THIS CLASS.").eol(); writer.append(" */").eol(); - if (processingContext.isGeneratedAvailable()) { - writer.append(Constants.AT_GENERATED).eol(); - } + writer.append(Constants.AT_GENERATED).eol(); writer.append(Constants.AT_TYPEQUERYBEAN).eol(); writer.append("public class Q%s extends TQRootBean<%1$s,Q%1$s> {", shortName).eol(); }