Spring: javadoc+checkstyle

jknack · jknack · commit 81768f8cd309 · 2019-07-09T14:13:45.000-03:00
diff --git a/docs/asciidoc/dependency-injection.adoc b/docs/asciidoc/dependency-injection.adoc
@@ -10,6 +10,6 @@ include::di-dagger.adoc[]
 
 include::modules/guice.adoc[]
 
-include::di-spring.adoc[]
+include::modules/spring.adoc[]
 
 include::di-weld.adoc[]
diff --git a/docs/asciidoc/modules/spring.adoc b/docs/asciidoc/modules/spring.adoc
diff --git a/modules/jooby-spring/src/main/java/io/jooby/di/ConfigPropertySource.java b/modules/jooby-spring/src/main/java/io/jooby/di/ConfigPropertySource.java
@@ -9,9 +9,22 @@
 import com.typesafe.config.ConfigException;
 import org.springframework.core.env.PropertySource;
 
+import javax.annotation.Nonnull;
+
+/**
+ * Property source backed by Jooby application configuration object.
+ *
+ * @author edgar
+ * @since 2.0.0
+ */
 public class ConfigPropertySource extends PropertySource<Config> {
-  public ConfigPropertySource(String name, Config source) {
-    super(name, source);
+  /**
+   * Creates a new property source.
+   *
+   * @param source Application configuration.
+   */
+  public ConfigPropertySource(@Nonnull Config source) {
+    super("jooby", source);
   }
 
   @Override public boolean containsProperty(String key) {
diff --git a/modules/jooby-spring/src/main/java/io/jooby/di/SpringModule.java b/modules/jooby-spring/src/main/java/io/jooby/di/SpringModule.java
@@ -22,6 +22,30 @@
 import javax.inject.Provider;
 import java.util.Map;
 
+/**
+ * Spring module: https://jooby.io/modules/spring.
+ *
+ * Jooby integrates the {@link io.jooby.ServiceRegistry} into the Spring Core framework.
+ *
+ * Usage:
+ *
+ * <pre>{@code
+ * {
+ *
+ *
+ *   install(new SpringModule());
+ *
+ * }
+ *
+ * }</pre>
+ *
+ * Require calls are going to be resolve by Spring now.
+ *
+ * Spring scan the {@link Jooby#getBasePackage()}, unless you specify them explicitly.
+ *
+ * @author edgar
+ * @since 2.0.0
+ */
 public class SpringModule implements Extension {
 
   private AnnotationConfigApplicationContext applicationContext;
@@ -32,24 +56,46 @@ public class SpringModule implements Extension {
 
   private String[] packages;
 
+  /**
+   * Creates a new Spring module using the given application context.
+   *
+   * @param applicationContext Application context to use.
+   */
   public SpringModule(@Nonnull AnnotationConfigApplicationContext applicationContext) {
     this.applicationContext = applicationContext;
   }
 
+  /**
+   * Creates a new Spring module, scan the default package: {@link Jooby#getBasePackage()}.
+   */
   public SpringModule() {
-    this.applicationContext = null;
   }
 
-  public SpringModule(String... packages) {
-    this.applicationContext = null;
+  /**
+   * Creates a new Spring module and scan the provided packages.
+   *
+   * @param packages Package to scan.
+   */
+  public SpringModule(@Nonnull String... packages) {
     this.packages = packages;
   }
 
+  /**
+   * Indicates the Spring application context should NOT be refreshed. Default is: true.
+   *
+   * @return This module.
+   */
   public SpringModule noRefresh() {
     this.refresh = false;
     return this;
   }
 
+  /**
+   * Turn off discovering/scanning of MVC routes. For Spring integration an MVC route must be
+   * annotated with {@link Controller}.
+   *
+   * @return This module.
+   */
   public SpringModule noMvcRoutes() {
     this.registerMvcRoutes = false;
     return this;
@@ -72,7 +118,8 @@ public SpringModule noMvcRoutes() {
       }
       Environment environment = application.getEnvironment();
 
-      applicationContext = defaultApplicationContext(packages);
+      applicationContext = new AnnotationConfigApplicationContext();
+      applicationContext.scan(packages);
 
       ConfigurableEnvironment configurableEnvironment = applicationContext.getEnvironment();
       String[] profiles = environment.getActiveNames().toArray(new String[0]);
@@ -81,7 +128,7 @@ public SpringModule noMvcRoutes() {
 
       Config config = environment.getConfig();
       MutablePropertySources propertySources = configurableEnvironment.getPropertySources();
-      propertySources.addFirst(new ConfigPropertySource("application", config));
+      propertySources.addFirst(new ConfigPropertySource(config));
 
       ConfigurableListableBeanFactory beanFactory = applicationContext.getBeanFactory();
       beanFactory.registerSingleton("conf", config);
@@ -116,11 +163,4 @@ public SpringModule noMvcRoutes() {
       }
     }
   }
-
-  public static AnnotationConfigApplicationContext defaultApplicationContext(
-      @Nonnull String... packages) {
-    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
-    context.scan(packages);
-    return context;
-  }
 }
diff --git a/modules/jooby-spring/src/main/java/io/jooby/di/SpringRegistry.java b/modules/jooby-spring/src/main/java/io/jooby/di/SpringRegistry.java
@@ -13,10 +13,10 @@
 
 import javax.annotation.Nonnull;
 
-public class SpringRegistry implements Registry {
+class SpringRegistry implements Registry {
   private final ApplicationContext ctx;
 
-  public SpringRegistry(ApplicationContext ctx) {
+  SpringRegistry(ApplicationContext ctx) {
     this.ctx = ctx;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,10 @@`
`13`	`13`
`14`	`14`	`import javax.annotation.Nonnull;`
`15`	`15`
`16`		`-public class SpringRegistry implements Registry {`
	`16`	`+class SpringRegistry implements Registry {`
`17`	`17`	`private final ApplicationContext ctx;`
`18`	`18`
`19`		`- public SpringRegistry(ApplicationContext ctx) {`
	`19`	`+ SpringRegistry(ApplicationContext ctx) {`
`20`	`20`	`this.ctx = ctx;`
`21`	`21`	`}`
`22`	`22`