Introduce nullability annotations and remove hard dependency on spotb…

…ugs (#4907)
micronaut-projects · Feb 9, 2021 · dcbc922 · dcbc922
1 parent 16a943f
commit dcbc922
Show file tree

Hide file tree

Showing 527 changed files with 1,226 additions and 1,513 deletions.
diff --git a/aop/src/main/java/io/micronaut/aop/MethodInvocationContext.java b/aop/src/main/java/io/micronaut/aop/MethodInvocationContext.java
@@ -17,7 +17,7 @@
 
 import io.micronaut.inject.ExecutableMethod;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 
 /**
  * Extended version of {@link InvocationContext} for {@link MethodInterceptor} instances.

diff --git a/aop/src/main/java/io/micronaut/aop/chain/InterceptorChain.java b/aop/src/main/java/io/micronaut/aop/chain/InterceptorChain.java
@@ -15,7 +15,7 @@
  */
 package io.micronaut.aop.chain;
 
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.Nullable;
 import io.micronaut.aop.*;
 import io.micronaut.aop.exceptions.UnimplementedAdviceException;
 import io.micronaut.context.ApplicationContext;
@@ -34,7 +34,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.lang.annotation.Annotation;
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;

diff --git a/aop/src/main/java/io/micronaut/aop/chain/MethodInterceptorChain.java b/aop/src/main/java/io/micronaut/aop/chain/MethodInterceptorChain.java
@@ -22,7 +22,7 @@
 import io.micronaut.core.type.ReturnType;
 import io.micronaut.inject.ExecutableMethod;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.lang.reflect.Method;
 
 /**

diff --git a/aop/src/main/java/io/micronaut/aop/writer/AopProxyWriter.java b/aop/src/main/java/io/micronaut/aop/writer/AopProxyWriter.java
@@ -15,7 +15,7 @@
  */
 package io.micronaut.aop.writer;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import io.micronaut.aop.HotSwappableInterceptedProxy;
 import io.micronaut.aop.Intercepted;
 import io.micronaut.aop.InterceptedProxy;

diff --git a/core/build.gradle b/core/build.gradle
@@ -9,8 +9,7 @@ shadowJar {
 dependencies {
     api dependencyVersion("slf4j")
     api dependencyVersion("reactive.streams")
-    api dependencyVersion("spotbugs")
-
+    compileOnly dependencyVersion('jsr305')
     compileOnly "org.graalvm.nativeimage:svm:$graalVersion"
     compileOnly "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlinVersion"    
 

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationClassValue.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationClassValue.java
@@ -17,8 +17,6 @@
 
 import io.micronaut.core.naming.Named;
 import io.micronaut.core.util.ArgumentUtils;
-
-import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.Objects;
 import java.util.Optional;
 

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadata.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadata.java
@@ -15,8 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.micronaut.core.naming.NameUtils;
 import io.micronaut.core.reflect.ClassUtils;
 import io.micronaut.core.reflect.ReflectionUtils;

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadataDelegate.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadataDelegate.java
@@ -15,8 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.value.OptionalValues;
 

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadataProvider.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadataProvider.java
@@ -15,7 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
 import java.lang.annotation.Annotation;
 import java.util.Optional;
 

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadataResolver.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationMetadataResolver.java
@@ -15,10 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
-
 /**
  * An interface for types capable of resolving {@link AnnotationMetadata}.
  *

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationSource.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationSource.java
@@ -15,8 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.micronaut.core.util.ArgumentUtils;
 
 import java.lang.annotation.Annotation;

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationUtil.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationUtil.java
@@ -57,6 +57,7 @@ public class AnnotationUtil {
      */
     public static final List<String> STEREOTYPE_EXCLUDES = Arrays.asList(
             "javax.annotation",
+            "io.micronaut.core.annotation",
             "edu.umd.cs.findbugs.annotations"
     );
 

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationValue.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationValue.java
@@ -15,8 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.micronaut.core.convert.ArgumentConversionContext;
 import io.micronaut.core.convert.ConversionContext;
 import io.micronaut.core.convert.ConversionService;

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationValueBuilder.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationValueBuilder.java
@@ -15,9 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
-
 import java.lang.annotation.Annotation;
 import java.lang.annotation.RetentionPolicy;
 import java.util.HashMap;

diff --git a/core/src/main/java/io/micronaut/core/annotation/AnnotationValueResolver.java b/core/src/main/java/io/micronaut/core/annotation/AnnotationValueResolver.java
@@ -16,8 +16,6 @@
 package io.micronaut.core.annotation;
 
 import io.micronaut.core.value.ValueResolver;
-
-import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.*;
 
 /**

diff --git a/core/src/main/java/io/micronaut/core/annotation/EmptyAnnotationMetadata.java b/core/src/main/java/io/micronaut/core/annotation/EmptyAnnotationMetadata.java
@@ -15,8 +15,6 @@
  */
 package io.micronaut.core.annotation;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.micronaut.core.reflect.ReflectionUtils;
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.util.StringUtils;

diff --git a/core/src/main/java/io/micronaut/core/annotation/NonNull.java b/core/src/main/java/io/micronaut/core/annotation/NonNull.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2017-2021 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
+ *
+ * https://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 io.micronaut.core.annotation;
+
+import javax.annotation.Nonnull;
+import javax.annotation.meta.TypeQualifierNickname;
+import java.lang.annotation.*;
+
+
+/**
+ * A common  annotation to declare that annotated elements cannot be {@code null}. Leverages JSR 305 meta-annotations to indicate
+ * nullability in Java to common tools with JSR 305 support and used by Kotlin to infer nullability of Spring API.
+ *
+ * <p>Should be used at parameter, return value, and field level. Method overrides should repeat parent {@code @NonNull} annotations unless
+ * they behave differently.</p>
+ *
+ * <p>Use {@code @NonNullApi} (scope = parameters + return values) to set the default behavior to non-nullable in order to avoid annotating
+ * your whole codebase with {@code @NonNull}.</p>
+ *
+ * @since 2.4
+ * @author graemerocher
+ * @see Nullable
+ */
+@Target({ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Nonnull
+@TypeQualifierNickname
+public @interface NonNull {
+}
diff --git a/core/src/main/java/io/micronaut/core/annotation/Nullable.java b/core/src/main/java/io/micronaut/core/annotation/Nullable.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2017-2021 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
+ *
+ * https://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 io.micronaut.core.annotation;
+
+import javax.annotation.Nonnull;
+import javax.annotation.meta.TypeQualifierNickname;
+import javax.annotation.meta.When;
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * A common annotation to declare that annotated elements can be {@code null} under some circumstance. Leverages JSR 305 meta-annotations to
+ * indicate nullability in Java to common tools with JSR 305 support and used by Kotlin to infer nullability of Spring API.
+ *
+ * <p>Should be used at parameter, return value, and field level. Methods override should repeat parent {@code @Nullable} annotations
+ * unless they behave differently.</p>
+ *
+ * @since 2.4
+ * @author graemerocher
+ * @see NonNull
+ */
+@Target({ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Nonnull(when = When.MAYBE)
+@TypeQualifierNickname
+public @interface Nullable {
+}
diff --git a/core/src/main/java/io/micronaut/core/attr/AttributeHolder.java b/core/src/main/java/io/micronaut/core/attr/AttributeHolder.java
@@ -18,7 +18,7 @@
 import io.micronaut.core.convert.value.ConvertibleValues;
 import io.micronaut.core.util.StringUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.util.Optional;
 
 /**

diff --git a/core/src/main/java/io/micronaut/core/attr/MutableAttributeHolder.java b/core/src/main/java/io/micronaut/core/attr/MutableAttributeHolder.java
@@ -15,8 +15,8 @@
  */
 package io.micronaut.core.attr;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
 import io.micronaut.core.convert.value.MutableConvertibleValues;
 import io.micronaut.core.util.StringUtils;
 

diff --git a/core/src/main/java/io/micronaut/core/beans/AbstractBeanIntrospection.java b/core/src/main/java/io/micronaut/core/beans/AbstractBeanIntrospection.java
@@ -24,8 +24,8 @@
 import io.micronaut.core.util.ArgumentUtils;
 import io.micronaut.core.util.StringUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
 
 import java.lang.annotation.Annotation;
 import java.util.*;

diff --git a/core/src/main/java/io/micronaut/core/beans/AbstractBeanIntrospectionReference.java b/core/src/main/java/io/micronaut/core/beans/AbstractBeanIntrospectionReference.java
@@ -18,7 +18,7 @@
 import io.micronaut.core.annotation.Internal;
 import io.micronaut.core.annotation.UsedByGeneratedCode;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 
 
 /**

diff --git a/core/src/main/java/io/micronaut/core/beans/AbstractBeanMethod.java b/core/src/main/java/io/micronaut/core/beans/AbstractBeanMethod.java
@@ -15,8 +15,8 @@
  */
 package io.micronaut.core.beans;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
 import io.micronaut.core.annotation.AnnotationMetadata;
 import io.micronaut.core.annotation.Internal;
 import io.micronaut.core.annotation.UsedByGeneratedCode;

diff --git a/core/src/main/java/io/micronaut/core/beans/AbstractBeanProperty.java b/core/src/main/java/io/micronaut/core/beans/AbstractBeanProperty.java
@@ -22,8 +22,8 @@
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
 
 import java.util.Objects;
 

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanIntrospection.java b/core/src/main/java/io/micronaut/core/beans/BeanIntrospection.java
@@ -21,7 +21,7 @@
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import javax.annotation.concurrent.Immutable;
 import java.lang.annotation.Annotation;
 import java.util.Collection;

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanIntrospectionMap.java b/core/src/main/java/io/micronaut/core/beans/BeanIntrospectionMap.java
@@ -19,7 +19,7 @@
 import io.micronaut.core.convert.ConversionService;
 import io.micronaut.core.util.CollectionUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.util.*;
 import java.util.stream.Collectors;
 

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanIntrospectionReference.java b/core/src/main/java/io/micronaut/core/beans/BeanIntrospectionReference.java
@@ -19,7 +19,7 @@
 import io.micronaut.core.annotation.Internal;
 import io.micronaut.core.naming.Named;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 
 /**
  * A reference to a {@link BeanIntrospection} that may or may not be present on the classpath.

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanIntrospector.java b/core/src/main/java/io/micronaut/core/beans/BeanIntrospector.java
@@ -18,7 +18,7 @@
 import io.micronaut.core.beans.exceptions.IntrospectionException;
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import javax.annotation.concurrent.Immutable;
 import java.lang.annotation.Annotation;
 import java.util.Arrays;

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanMap.java b/core/src/main/java/io/micronaut/core/beans/BeanMap.java
@@ -17,7 +17,7 @@
 
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.util.Map;
 
 /**

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanMethod.java b/core/src/main/java/io/micronaut/core/beans/BeanMethod.java
@@ -15,7 +15,7 @@
  */
 package io.micronaut.core.beans;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import io.micronaut.core.naming.Named;
 import io.micronaut.core.type.Executable;
 import io.micronaut.core.type.ReturnType;

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanProperty.java b/core/src/main/java/io/micronaut/core/beans/BeanProperty.java
@@ -24,8 +24,8 @@
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 import java.util.Arrays;
 import java.util.Collection;

diff --git a/core/src/main/java/io/micronaut/core/beans/BeanWrapper.java b/core/src/main/java/io/micronaut/core/beans/BeanWrapper.java
@@ -24,8 +24,8 @@
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
 import java.util.Collection;
 import java.util.Optional;
 

diff --git a/core/src/main/java/io/micronaut/core/beans/DefaultBeanIntrospector.java b/core/src/main/java/io/micronaut/core/beans/DefaultBeanIntrospector.java
@@ -22,7 +22,7 @@
 import io.micronaut.core.util.ArgumentUtils;
 import org.slf4j.Logger;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;

diff --git a/core/src/main/java/io/micronaut/core/beans/DefaultBeanWrapper.java b/core/src/main/java/io/micronaut/core/beans/DefaultBeanWrapper.java
@@ -18,7 +18,7 @@
 import io.micronaut.core.annotation.Internal;
 import io.micronaut.core.util.ArgumentUtils;
 
-import edu.umd.cs.findbugs.annotations.NonNull;
+import io.micronaut.core.annotation.NonNull;
 import java.util.Objects;
 
 /**