Add @NotNull annotations

Author: pmendelski

README.md

@@ -11,6 +11,7 @@
 - has conditional bean registration mechanism
 - detects slow bean creation
 - provides [event bus](https://github.com/coditory/quark-eventbus) integration
+- public API annotated with `@NotNull` and `@Nullable` for better [kotlin integration](https://kotlinlang.org/docs/java-to-kotlin-nullability-guide.html#platform-types)
 
 ## Installation
 

build.gradle

@@ -14,7 +14,7 @@ description = 'Coditory Quark Context Library'
 dependencies {
     api 'org.slf4j:slf4j-api:2.0.3'
     api 'org.jetbrains:annotations:23.0.0'
-    api 'com.coditory.quark:quark-eventbus:0.0.4'
+    api 'com.coditory.quark:quark-eventbus:0.0.5'
     testImplementation 'ch.qos.logback:logback-classic:1.4.4'
     testImplementation 'org.spockframework:spock-core:2.3-groovy-4.0'
     testImplementation 'org.skyscreamer:jsonassert:1.5.1'

src/main/java/com/coditory/quark/context/BeanCreator.java

@@ -1,10 +1,13 @@
 package com.coditory.quark.context;
 
+import org.jetbrains.annotations.NotNull;
+
 @FunctionalInterface
 public interface BeanCreator<T> {
-    T create(ResolutionContext context);
+    @NotNull
+    T create(@NotNull ResolutionContext context);
 
-    default boolean isActive(ConditionContext context) {
+    default boolean isActive(@NotNull ConditionContext context) {
         return true;
     }
 }

src/main/java/com/coditory/quark/context/BeanDescriptor.java

@@ -1,29 +1,35 @@
 package com.coditory.quark.context;
 
+import org.jetbrains.annotations.NotNull;
+
 import static java.util.Objects.requireNonNull;
 
 public record BeanDescriptor<T>(Class<T> type, String name) {
-    public static <T> BeanDescriptor<T> descriptor(Class<T> type) {
+    @NotNull
+    public static <T> BeanDescriptor<T> descriptor(@NotNull Class<T> type) {
         return new BeanDescriptor<>(type, null);
     }
 
-    public static <T> BeanDescriptor<T> descriptor(Class<T> type, String name) {
+    @NotNull
+    public static <T> BeanDescriptor<T> descriptor(@NotNull Class<T> type, String name) {
         return new BeanDescriptor<>(type, name);
     }
 
-    public BeanDescriptor(Class<T> type, String name) {
+    public BeanDescriptor(@NotNull Class<T> type, String name) {
         this.type = requireNonNull(type);
         this.name = name == null || name.isBlank() ? null : name;
     }
 
-    public <R> BeanDescriptor<R> withType(Class<R> type) {
+    @NotNull
+    public <R> BeanDescriptor<R> withType(@NotNull Class<R> type) {
         return new BeanDescriptor<>(type, name);
     }
 
     public boolean hasName() {
         return name != null;
     }
 
+    @NotNull
     public String toShortString() {
         return name != null
                 ? type.getSimpleName() + ":" + name
@@ -32,8 +38,6 @@ public String toShortString() {
 
     @Override
     public String toString() {
-        return name != null
-                ? type.getSimpleName() + ":" + name
-                : type.getSimpleName();
+        return "BeanDescriptor{" + toShortString() + "}";
     }
 }

src/main/java/com/coditory/quark/context/BeanFinalizationException.java

@@ -1,11 +1,7 @@
 package com.coditory.quark.context;
 
-public class BeanFinalizationException extends RuntimeException {
-    public BeanFinalizationException(String message) {
-        super(message);
-    }
-
-    public BeanFinalizationException(String message, Throwable cause) {
+public final class BeanFinalizationException extends RuntimeException {
+    BeanFinalizationException(String message, Throwable cause) {
         super(message, cause);
     }
 }

src/main/java/com/coditory/quark/context/BeanInitializationException.java

@@ -1,11 +1,7 @@
 package com.coditory.quark.context;
 
 public class BeanInitializationException extends RuntimeException {
-    public BeanInitializationException(String message) {
-        super(message);
-    }
-
-    public BeanInitializationException(String message, Throwable cause) {
+    BeanInitializationException(String message, Throwable cause) {
         super(message, cause);
     }
 }

src/main/java/com/coditory/quark/context/BeanTimer.java

@@ -10,7 +10,7 @@
 import static java.util.Objects.requireNonNull;
 import static java.util.stream.Collectors.toSet;
 
-class ConditionContext {
+final class ConditionContext {
     static ConditionContext from(Set<BeanHolder<?>> holders, Map<String, Object> properties) {
         Set<BeanDescriptor<?>> descriptors = holders.stream()
                 .map(BeanHolder::getDescriptor)

src/main/java/com/coditory/quark/context/ConditionContext.java

@@ -17,15 +17,15 @@ private ConditionsResolver() {
         throw new UnsupportedOperationException("Do not instantiate utility class");
     }
 
-    public static boolean isActive(ConditionContext context, Method method) {
+    static boolean isActive(ConditionContext context, Method method) {
         return isActive(context, method.getAnnotations());
     }
 
-    public static boolean isActive(ConditionContext context, Class<?> type) {
+    static boolean isActive(ConditionContext context, Class<?> type) {
         return isActive(context, type.getAnnotations());
     }
 
-    private static boolean isActive(ConditionContext context, Annotation[] annotations) {
+    static boolean isActive(ConditionContext context, Annotation[] annotations) {
         return Arrays.stream(annotations)
                 .allMatch(annotation -> isActive(context, annotation));
     }

src/main/java/com/coditory/quark/context/ConditionsResolver.java

@@ -1,6 +1,7 @@
 package com.coditory.quark.context;
 
 import com.coditory.quark.context.annotations.Inject;
+import org.jetbrains.annotations.NotNull;
 
 import java.lang.reflect.Constructor;
 import java.util.Arrays;
@@ -44,8 +45,9 @@ static <T> ConstructorBasedBeanCreator<T> fromConstructor(Class<T> type) {
         this.constructor = requireNonNull(constructor);
     }
 
+    @NotNull
     @Override
-    public T create(ResolutionContext context) {
+    public T create(@NotNull ResolutionContext context) {
         Object[] args = resolveArguments(constructor, context);
         try {
             return constructor.newInstance(args);
@@ -55,7 +57,7 @@ public T create(ResolutionContext context) {
     }
 
     @Override
-    public boolean isActive(ConditionContext context) {
+    public boolean isActive(@NotNull ConditionContext context) {
         return ConditionsResolver.isActive(context, type);
     }
 }