Fix javadoc, add request scope example, remove BeanLifecycle

Author: rbygrave

inject/src/main/java/io/avaje/inject/ApplicationScope.java

@@ -3,9 +3,9 @@
 import java.util.List;
 
 /**
- * Provides a global system wide BeanScope that contains all the bean contexts in the classpath.
+ * Provides a global system wide BeanScope that contains all the beans.
  * <p>
- * This will automatically get all the bean contexts and wire them all as necessary. It will use
+ * This will automatically get all the beans and wire them all as necessary. It will use
  * a shutdown hook to fire any <code>@PreDestroy</code> methods on beans.
  * </p>
  *
@@ -140,6 +140,35 @@ public static List<Object> listByAnnotation(Class<?> annotation) {
   /**
    * Start building a RequestScope.
    *
+   * <pre>{@code
+   *
+   *   try (RequestScope requestScope = ApplicationScope.newRequestScope()
+   *       // supply some instances
+   *       .withBean(HttpRequest.class, request)
+   *       .withBean(HttpResponse.class, response)
+   *       .build()) {
+   *
+   *       MyController controller = requestScope.get(MyController.class);
+   *       controller.process();
+   *
+   *   }
+   *
+   *   ...
+   *
+   *   // define request scoped beans
+   *   @Request
+   *   MyController {
+   *
+   *     // can depend on supplied instances, singletons and other request scope beans
+   *     @Inject
+   *     MyController(HttpRequest request, HttpResponse response, MyService myService) {
+   *       ...
+   *     }
+   *
+   *   }
+   *
+   * }</pre>
+   *
    * @return The request scope builder
    */
   public static RequestScopeBuilder newRequestScope() {

inject/src/main/java/io/avaje/inject/BeanScope.java

@@ -45,7 +45,7 @@
 public interface BeanScope extends Closeable {
 
   /**
-   * Build a bean context with options for shutdown hook and supplying test doubles.
+   * Build a bean scope with options for shutdown hook and supplying test doubles.
    * <p>
    * We would choose to use BeanScopeBuilder in test code (for component testing)
    * as it gives us the ability to inject test doubles, mocks, spy's etc.
@@ -70,7 +70,6 @@ public interface BeanScope extends Closeable {
    *       assertThat(...
    *     }
    *   }
-   *
    * }</pre>
    */
   static BeanScopeBuilder newBuilder() {
@@ -80,6 +79,34 @@ static BeanScopeBuilder newBuilder() {
   /**
    * Create a RequestScope via builder where we provide extra instances
    * that can be used/included in wiring request scoped beans.
+   *
+   * <pre>{@code
+   *
+   *   try (RequestScope requestScope = beanScope.newRequestScope()
+   *       // supply some instances
+   *       .withBean(HttpRequest.class, request)
+   *       .withBean(HttpResponse.class, response)
+   *       .build()) {
+   *
+   *       MyController controller = requestScope.get(MyController.class);
+   *       controller.process();
+   *   }
+   *
+   *   ...
+   *
+   *   // define request scoped beans
+   *   @Request
+   *   MyController {
+   *
+   *     // can depend on supplied instances, singletons and other request scope beans
+   *     @Inject
+   *     MyController(HttpRequest request, HttpResponse response, MyService myService) {
+   *       ...
+   *     }
+   *
+   *   }
+   *
+   * }</pre>
    */
   RequestScopeBuilder newRequestScope();
 

inject/src/main/java/io/avaje/inject/BeanScopeBuilder.java

@@ -3,7 +3,7 @@
 import java.util.function.Consumer;
 
 /**
- * Build a bean context with options for shutdown hook and supplying test doubles.
+ * Build a bean scope with options for shutdown hook and supplying test doubles.
  * <p>
  * We would choose to use BeanScopeBuilder in test code (for component testing) as it gives us
  * the ability to inject test doubles, mocks, spy's etc.
@@ -34,7 +34,7 @@
 public interface BeanScopeBuilder {
 
   /**
-   * Create the bean context without registering a shutdown hook.
+   * Create the bean scope without registering a shutdown hook.
    * <p>
    * The expectation is that the BeanScopeBuilder is closed via code or via using
    * try with resources.
@@ -286,7 +286,7 @@ public interface BeanScopeBuilder {
   <D> BeanScopeBuilder withSpy(Class<D> type, Consumer<D> consumer);
 
   /**
-   * Build and return the bean context.
+   * Build and return the bean scope.
    *
    * @return The BeanScope
    */

inject/src/main/java/io/avaje/inject/ContextModule.java

@@ -1,14 +1,14 @@
 package io.avaje.inject;
 
 /**
- * Used to explicitly name a bean context and optionally specify if it depends on other bean contexts.
+ * Used to explicitly name a bean scope and optionally specify if it depends on other bean scopes.
  * <p>
  * If this annotation is not present then the name will be derived as the "top level package name"
  * e.g. "org.example.featuretoggle"
  * </p>
  *
  * <p>
- * Typically there is a single bean context per Jar (module). In that sense the name is the "module name" and
+ * Typically there is a single bean scope per Jar (module). In that sense the name is the "module name" and
  * the dependsOn specifies the names of modules that this depends on (provide beans that are used to wire this module).
  * </p>
  *

inject/src/main/java/io/avaje/inject/DBeanScopeBuilder.java

@@ -7,13 +7,11 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.lang.annotation.Annotation;
 import java.util.*;
-import java.util.concurrent.locks.ReentrantLock;
 import java.util.function.Consumer;
 
 /**
- * Build a bean context with options for shutdown hook and supplying test doubles.
+ * Build a bean scope with options for shutdown hook and supplying test doubles.
  */
 class DBeanScopeBuilder implements BeanScopeBuilder {
 

inject/src/main/java/io/avaje/inject/SystemContext.java

@@ -5,9 +5,9 @@
 /**
  * Deprecated - migrate to ApplicationScope.
  * <p>
- * Provides a global system wide BeanScope that contains all the bean contexts in the classpath.
+ * Provides a global system wide BeanScope that contains all the beans.
  * <p>
- * This will automatically get all the bean contexts and wire them all as necessary. It will use
+ * This will automatically get all the beans and wire them all as necessary. It will use
  * a shutdown hook to fire any <code>@PreDestroy</code> methods on beans.
  * </p>
  *

inject/src/main/java/io/avaje/inject/spi/BeanContextFactory.java

@@ -1,12 +1,12 @@
 package io.avaje.inject.spi;
 
 /**
- * This is the service loader interface defining the bean contexts that can be created.
+ * This is the service loader interface defining the bean scope.
  */
 public interface BeanContextFactory {
 
   /**
-   * Return the name of the bean context (module) this will create.
+   * Return the name of the bean scope (module) this will create.
    */
   String getName();
 
@@ -16,7 +16,7 @@ public interface BeanContextFactory {
   String[] getProvides();
 
   /**
-   * Return the names of bean contexts (modules) that this is dependent on (they need to be built before this one).
+   * Return the names of bean scopes (modules) that this is dependent on (they need to be built before this one).
    */
   String[] getDependsOn();
 

inject/src/main/java/io/avaje/inject/spi/BeanLifecycle.java

@@ -11,7 +11,7 @@
 import java.util.function.Consumer;
 
 /**
- * Mutable builder object used when building a bean context.
+ * Mutable builder object used when building a bean scope.
  */
 public interface Builder {
 
@@ -161,7 +161,7 @@ static Builder newBuilder(List<SuppliedBean> suppliedBeans, List<EnrichBean> enr
   <T> T enrich(T bean, Class<?>[] types);
 
   /**
-   * Build and return the bean context.
+   * Build and return the bean scope.
    */
   BeanScope build(boolean withShutdownHook);
 }

inject/src/main/java/io/avaje/inject/spi/Builder.java

@@ -1,4 +1,4 @@
 /**
- * Building bean context objects expected to only be used by generated code.
+ * Building bean scope objects expected to only be used by generated code.
  */
 package io.avaje.inject.spi;