Annotated AnnotatedElement and its implementations

typetools · Aug 12, 2020 · aadd76c · aadd76c
1 parent 9f1bd75
commit aadd76c
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 11 deletions.
diff --git a/src/java.base/share/classes/java/lang/Class.java b/src/java.base/share/classes/java/lang/Class.java
@@ -3742,7 +3742,7 @@ public Annotation[] getAnnotations() {
      */
     @Override
     @SuppressWarnings("unchecked")
-    public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationClass) {
+    public <A extends Annotation> @Nullable A getDeclaredAnnotation(Class<A> annotationClass) {
         Objects.requireNonNull(annotationClass);
 
         return (A) annotationData().declaredAnnotations.get(annotationClass);

diff --git a/src/java.base/share/classes/java/lang/Package.java b/src/java.base/share/classes/java/lang/Package.java
@@ -489,7 +489,7 @@ public Annotation[] getAnnotations() {
      * @since 1.8
      */
     @Override
-    public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationClass) {
+    public <A extends Annotation> @Nullable A getDeclaredAnnotation(Class<A> annotationClass) {
         return getPackageInfo().getDeclaredAnnotation(annotationClass);
     }
 

diff --git a/src/java.base/share/classes/java/lang/reflect/AccessibleObject.java b/src/java.base/share/classes/java/lang/reflect/AccessibleObject.java
@@ -25,6 +25,10 @@
 
 package java.lang.reflect;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.checkerframework.framework.qual.AnnotatedFor;
+import org.checkerframework.framework.qual.CFComment;
+
 import java.lang.annotation.Annotation;
 import java.lang.invoke.MethodHandle;
 import java.security.AccessController;
@@ -72,6 +76,7 @@
  * @revised 9
  * @spec JPMS
  */
+@AnnotatedFor({"nullness"})
 public class AccessibleObject implements AnnotatedElement {
 
     static void checkPermission() {
@@ -444,6 +449,7 @@ public boolean isAccessible() {
      * @see #setAccessible(boolean)
      */
     @CallerSensitive
+    @CFComment("Sometimes null is forbidden; other times, it is required")
     public final boolean canAccess(Object obj) {
         if (!Member.class.isInstance(this)) {
             return override;
@@ -503,7 +509,7 @@ protected AccessibleObject() {}
      * @throws NullPointerException {@inheritDoc}
      * @since 1.5
      */
-    public <T extends Annotation> T getAnnotation(Class<T> annotationClass) {
+    public <T extends Annotation> @Nullable T getAnnotation(Class<T> annotationClass) {
         throw new AssertionError("All subclasses should override this method");
     }
 
@@ -538,7 +544,7 @@ public Annotation[] getAnnotations() {
      * @since 1.8
      */
     @Override
-    public <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass) {
+    public <T extends Annotation> @Nullable T getDeclaredAnnotation(Class<T> annotationClass) {
         // Only annotations on classes are inherited, for all other
         // objects getDeclaredAnnotation is the same as
         // getAnnotation.

diff --git a/src/java.base/share/classes/java/lang/reflect/AnnotatedElement.java b/src/java.base/share/classes/java/lang/reflect/AnnotatedElement.java
@@ -293,7 +293,7 @@ default boolean isAnnotationPresent(@GuardSatisfied AnnotatedElement this, Class
      * @throws NullPointerException if the given annotation class is null
      * @since 1.5
      */
-    <T extends @Nullable Annotation> @Nullable T getAnnotation(Class<T> annotationClass);
+    <T extends Annotation> @Nullable T getAnnotation(Class<T> annotationClass);
 
     /**
      * Returns annotations that are <em>present</em> on this element.

diff --git a/src/java.base/share/classes/java/lang/reflect/Executable.java b/src/java.base/share/classes/java/lang/reflect/Executable.java
@@ -25,6 +25,9 @@
 
 package java.lang.reflect;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.checkerframework.framework.qual.AnnotatedFor;
+
 import java.lang.annotation.*;
 import java.util.Map;
 import java.util.Objects;
@@ -43,6 +46,7 @@
  *
  * @since 1.8
  */
+@AnnotatedFor({"nullness"})
 public abstract class Executable extends AccessibleObject
     implements Member, GenericDeclaration {
     /*
@@ -567,7 +571,7 @@ Annotation[][] sharedGetParameterAnnotations(Class<?>[] parameterTypes,
      * {@inheritDoc}
      * @throws NullPointerException  {@inheritDoc}
      */
-    public <T extends Annotation> T getAnnotation(Class<T> annotationClass) {
+    public <T extends Annotation> @Nullable T getAnnotation(Class<T> annotationClass) {
         Objects.requireNonNull(annotationClass);
         return annotationClass.cast(declaredAnnotations().get(annotationClass));
     }
@@ -670,7 +674,7 @@ AnnotatedType getAnnotatedReturnType0(Type returnType) {
      * constructor represented by this {@code Executable} or {@code null} if
      * this {@code Executable} can not have a receiver parameter
      */
-    public AnnotatedType getAnnotatedReceiverType() {
+    public @Nullable AnnotatedType getAnnotatedReceiverType() {
         if (Modifier.isStatic(this.getModifiers()))
             return null;
         return TypeAnnotationParser.buildAnnotatedType(getTypeAnnotationBytes0(),

diff --git a/src/java.base/share/classes/java/lang/reflect/Field.java b/src/java.base/share/classes/java/lang/reflect/Field.java
@@ -1177,7 +1177,7 @@ Field getRoot() {
      * @since 1.5
      */
     @SideEffectFree
-    public <T extends @Nullable Annotation> @Nullable T getAnnotation(@GuardSatisfied Field this, Class<@NonNull T> annotationClass) {
+    public <T extends Annotation> @Nullable T getAnnotation(@GuardSatisfied Field this, Class<T> annotationClass) {
         Objects.requireNonNull(annotationClass);
         return annotationClass.cast(declaredAnnotations().get(annotationClass));
     }

diff --git a/src/java.base/share/classes/java/lang/reflect/GenericDeclaration.java b/src/java.base/share/classes/java/lang/reflect/GenericDeclaration.java
@@ -25,11 +25,14 @@
 
 package java.lang.reflect;
 
+import org.checkerframework.framework.qual.AnnotatedFor;
+
 /**
  * A common interface for all entities that declare type variables.
  *
  * @since 1.5
  */
+@AnnotatedFor({"nullness"})
 public interface GenericDeclaration extends AnnotatedElement {
     /**
      * Returns an array of {@code TypeVariable} objects that

diff --git a/src/java.base/share/classes/java/lang/reflect/Method.java b/src/java.base/share/classes/java/lang/reflect/Method.java
@@ -714,7 +714,7 @@ void setMethodAccessor(MethodAccessor accessor) {
      * @throws NullPointerException  {@inheritDoc}
      * @since 1.5
      */
-    public <T extends @Nullable Annotation> @Nullable T getAnnotation(Class<T> annotationClass) {
+    public <T extends Annotation> @Nullable T getAnnotation(Class<T> annotationClass) {
         return super.getAnnotation(annotationClass);
     }
 

diff --git a/src/java.base/share/classes/java/lang/reflect/Parameter.java b/src/java.base/share/classes/java/lang/reflect/Parameter.java
@@ -29,6 +29,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.checkerframework.dataflow.qual.Pure;
 import org.checkerframework.dataflow.qual.SideEffectFree;
+import org.checkerframework.framework.qual.AnnotatedFor;
 
 import java.lang.annotation.*;
 import java.util.HashMap;
@@ -45,6 +46,7 @@
  *
  * @since 1.8
  */
+@AnnotatedFor({"nullness"})
 public final class Parameter implements AnnotatedElement {
 
     private final String name;
@@ -290,7 +292,7 @@ public boolean isVarArgs() {
      * {@inheritDoc}
      * @throws NullPointerException {@inheritDoc}
      */
-    public <T extends Annotation> T getAnnotation(Class<T> annotationClass) {
+    public <T extends Annotation> @Nullable T getAnnotation(Class<T> annotationClass) {
         Objects.requireNonNull(annotationClass);
         return annotationClass.cast(declaredAnnotations().get(annotationClass));
     }
@@ -316,7 +318,7 @@ public Annotation[] getDeclaredAnnotations() {
     /**
      * @throws NullPointerException {@inheritDoc}
      */
-    public <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass) {
+    public <T extends Annotation> @Nullable T getDeclaredAnnotation(Class<T> annotationClass) {
         // Only annotations on classes are inherited, for all other
         // objects getDeclaredAnnotation is the same as
         // getAnnotation.