You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sling.apache.org by GitBox <gi...@apache.org> on 2022/11/08 14:24:33 UTC
[GitHub] [sling-org-apache-sling-models-api] stefanseifert commented on a diff in pull request #8: SLING-11507 - Field injection should not inject static fields
stefanseifert commented on code in PR #8:
URL: https://github.com/apache/sling-org-apache-sling-models-api/pull/8#discussion_r1016697844
##########
src/main/java/org/apache/sling/models/annotations/apt/ValidatingAnnotationProcessor.java:
##########
@@ -0,0 +1,79 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+package org.apache.sling.models.annotations.apt;
+
+import java.util.Set;
+
+import javax.annotation.processing.AbstractProcessor;
+import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedAnnotationTypes;
+import javax.annotation.processing.SupportedSourceVersion;
+import javax.lang.model.SourceVersion;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.Modifier;
+import javax.lang.model.element.TypeElement;
+import javax.tools.Diagnostic.Kind;
+
+import org.apache.sling.models.annotations.Model;
+
+/**
+ * Annotation processor that implements compile-time validation for Sling Models
+ */
+@SupportedAnnotationTypes({
+ "javax.inject.Inject",
+ "org.apache.sling.models.annotations.injectorspecific.*",
+})
+@SupportedSourceVersion(SourceVersion.RELEASE_8)
+public class ValidatingAnnotationProcessor extends AbstractProcessor {
+
+ @Override
+ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+ for (TypeElement annotation : annotations) {
+ for (Element annotatedElement : roundEnv.getElementsAnnotatedWith(annotation)) {
+ if (!annotatedElement.getModifiers().contains(Modifier.STATIC) || !isSlingModel(annotatedElement)) {
+ // skip if not static, or the enclosing class/interface is not a sling model
+ continue;
+ }
+
+ if (annotatedElement.getKind() == ElementKind.FIELD) {
+ processingEnv.getMessager().printMessage(
+ Kind.ERROR,
+ "Annotation " + annotation + " may not be used on static fields",
Review Comment:
i think we should include the actual field name in the log message
##########
src/main/java/org/apache/sling/models/annotations/apt/ValidatingAnnotationProcessor.java:
##########
@@ -0,0 +1,79 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+package org.apache.sling.models.annotations.apt;
+
+import java.util.Set;
+
+import javax.annotation.processing.AbstractProcessor;
+import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedAnnotationTypes;
+import javax.annotation.processing.SupportedSourceVersion;
+import javax.lang.model.SourceVersion;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.Modifier;
+import javax.lang.model.element.TypeElement;
+import javax.tools.Diagnostic.Kind;
+
+import org.apache.sling.models.annotations.Model;
+
+/**
+ * Annotation processor that implements compile-time validation for Sling Models
+ */
+@SupportedAnnotationTypes({
+ "javax.inject.Inject",
+ "org.apache.sling.models.annotations.injectorspecific.*",
+})
+@SupportedSourceVersion(SourceVersion.RELEASE_8)
+public class ValidatingAnnotationProcessor extends AbstractProcessor {
+
+ @Override
+ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+ for (TypeElement annotation : annotations) {
+ for (Element annotatedElement : roundEnv.getElementsAnnotatedWith(annotation)) {
+ if (!annotatedElement.getModifiers().contains(Modifier.STATIC) || !isSlingModel(annotatedElement)) {
+ // skip if not static, or the enclosing class/interface is not a sling model
+ continue;
+ }
+
+ if (annotatedElement.getKind() == ElementKind.FIELD) {
+ processingEnv.getMessager().printMessage(
+ Kind.ERROR,
+ "Annotation " + annotation + " may not be used on static fields",
+ annotatedElement
+ );
+ } else if (annotatedElement.getKind() == ElementKind.METHOD) {
+ processingEnv.getMessager().printMessage(
+ Kind.ERROR,
+ "Annotation " + annotation + " may not be used on static methods",
+ annotatedElement
Review Comment:
i think we should include the actual method name in the log message
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org