Rename Pico Module (helidon-io#6682)

* resolved issue helidon-io#6610

Author: trentjeff

nima/webserver/webserver/src/main/java/module-info.java

@@ -17,6 +17,7 @@
 import io.helidon.common.features.api.Feature;
 import io.helidon.common.features.api.HelidonFlavor;
 import io.helidon.nima.webserver.http.spi.SinkProvider;
+import io.helidon.pico.api.ModuleComponent;
 
 /**
  * Loom based WebServer.
@@ -72,5 +73,5 @@
     uses SinkProvider;
 
     provides io.helidon.nima.webserver.spi.ServerConnectionProvider with io.helidon.nima.webserver.http1.Http1ConnectionProvider;
-    provides io.helidon.pico.api.Module with io.helidon.nima.webserver.Pico$$Module;
+    provides ModuleComponent with io.helidon.nima.webserver.Pico$$Module;
 }

pico/README.md

@@ -49,7 +49,7 @@ Request and Session scopes are simply not made available in Pico. We believe tha
 * Dependency - An <i>injection point</i> represents what is considered to be a dependency, perhaps <i>qualified</i> or Optional, on another service or contract.  This is just another what to describe an <i>injection point</i>.
 * Activator (aka ServiceProvider) - This is what is code generated by Pico to lazily activate your <i>service</i> instance(s) in the Pico <i>services registry</i>, and it handles resolving all <i>dependencies</i> it has, along with <i>inject</i>ing the fields, methods, etc. that are required to be satisfied as part of that activation process.
 * Services (aka services registry) - This is the collection of all services that are known to the JVM/runtime in Pico.
-* Module - This is where your application will "bind" services into the <i>services registry</i> - typically code generated, and typically with one module per jar/module in your application.
+* ModuleComponent - This is where your application will "bind" services into the <i>services registry</i> - typically code generated, and typically with one module per jar/module in your application.
 * Application - The fully realized set of modules and services/service providers that constitute your application, and code-generated using <b>Helidon Pico Tooling</b>.
 
 ## Getting Started

pico/api/src/main/java/io/helidon/pico/api/Application.java

@@ -25,7 +25,7 @@
  * <p>
  * Note: instances of this type are not eligible for injection.
  *
- * @see Module
+ * @see ModuleComponent
  */
 @Contract
 public interface Application extends OptionallyNamed {

…ain/java/io/helidon/pico/api/Module.java …io/helidon/pico/api/ModuleComponent.javapico/api/src/main/java/io/helidon/pico/api/Module.java renamed to pico/api/src/main/java/io/helidon/pico/api/ModuleComponent.java pico/api/src/main/java/io/helidon/pico/api/Module.java renamed to pico/api/src/main/java/io/helidon/pico/api/ModuleComponent.java

@@ -29,7 +29,7 @@
  * @see Application
  */
 @Contract
-public interface Module extends OptionallyNamed {
+public interface ModuleComponent extends OptionallyNamed {
 
     /**
      * Called by the provider implementation at bootstrapping time to bind all services / service providers to the

pico/api/src/main/java/io/helidon/pico/api/PicoServicesConfig.java

@@ -279,25 +279,25 @@ public boolean usesCompileTimeApplications() {
 
 
     /**
-     * The key that controls whether any {@link io.helidon.pico.api.Module}'s
+     * The key that controls whether any {@link io.helidon.pico.api.ModuleComponent}'s
      * (typically produced at compile-time by Pico tooling) can be discovered and is used during Pico startup processing. It is
      * strongly suggested for developers to adopt a compile-time strategy for producing the dependency/injection model as it will
      * lead to faster startup times as well as be deterministic and validated during compile-time instead of at runtime.
      */
     public static final String KEY_USES_COMPILE_TIME_MODULES = "uses-compile-time-modules";
     /**
-     * The default value for this is true, meaning that the Pico will attempt to find and use {@link io.helidon.pico.api.Module} code
+     * The default value for this is true, meaning that the Pico will attempt to find and use {@link io.helidon.pico.api.ModuleComponent} code
      * generated during compile-time (see Pico's APT <i>processor</i> and <i>maven-plugin</i> modules for usage).
      */
     public static final String DEFAULT_USES_COMPILE_TIME_MODULES = "true";
 
     /**
-     * Flag indicating whether compile-time generated {@link io.helidon.pico.api.Module}'s should be used at Pico's startup
+     * Flag indicating whether compile-time generated {@link io.helidon.pico.api.ModuleComponent}'s should be used at Pico's startup
      * initialization. Setting this value to false will have no affect if the underlying provider does not support compile-time
      * generation via {@link #supportsCompileTime()}.
      *
      * @return the flag indicating whether the provider is permitted to use Application generated code from compile-time
-     * @see io.helidon.pico.api.Module
+     * @see ModuleComponent
      * @see io.helidon.pico.api.Activator
      */
     @ConfiguredOption(key = KEY_USES_COMPILE_TIME_MODULES, value = DEFAULT_USES_COMPILE_TIME_MODULES)
@@ -310,7 +310,7 @@ public boolean usesCompileTimeModules() {
      * The key that represents whether the provider supports compile-time code generation of DI artifacts.
      *
      * @see io.helidon.pico.api.Application
-     * @see io.helidon.pico.api.Module
+     * @see io.helidon.pico.api.ModuleComponent
      * @see io.helidon.pico.api.Activator
      * @see #usesCompileTimeApplications()
      * @see #usesCompileTimeModules()

pico/api/src/main/java/io/helidon/pico/api/ServiceProvider.java

@@ -115,7 +115,7 @@ public interface ServiceProvider<T> extends InjectionPointProvider<T>, Weighted
      * The agent/instance to be used for binding this service provider to the pico application that was code generated.
      *
      * @return the service provider that should be used for binding, or empty if this provider does not support binding
-     * @see Module
+     * @see ModuleComponent
      * @see ServiceBinder
      * @see ServiceProviderBindable
      */

pico/api/src/main/java/io/helidon/pico/api/ServiceProviderBindable.java

@@ -23,7 +23,7 @@
  * and thereby works in conjunction with the {@link ServiceBinder} during pico service registry
  * initialization.
  * <p>
- * The only guarantee the provider implementation has is ensuring that {@link Module} instances
+ * The only guarantee the provider implementation has is ensuring that {@link ModuleComponent} instances
  * are bound to the pico services instances, as well as informed on the module name.
  * <p>
  * Generally this class should be called internally by the framework, and typically occurs only during initialization sequences.
@@ -36,7 +36,7 @@ public interface ServiceProviderBindable<T> extends ServiceProvider<T> {
 
     /**
      * Called to inform a service provider the module name it is bound to. Will only be called when there is a non-null
-     * module name associated for the given {@link Module}. A service provider can be associated with
+     * module name associated for the given {@link ModuleComponent}. A service provider can be associated with
      * 0..1 modules.
      *
      * @param moduleName the non-null module name

pico/maven-plugin/src/main/java/io/helidon/pico/maven/plugin/AbstractApplicationCreatorMojo.java

@@ -37,7 +37,7 @@
 import io.helidon.pico.api.CallingContextFactory;
 import io.helidon.pico.api.DefaultCallingContext;
 import io.helidon.pico.api.DefaultServiceInfoCriteria;
-import io.helidon.pico.api.Module;
+import io.helidon.pico.api.ModuleComponent;
 import io.helidon.pico.api.PicoServices;
 import io.helidon.pico.api.PicoServicesConfig;
 import io.helidon.pico.api.ServiceProvider;
@@ -143,9 +143,9 @@ String getThisModuleName() {
         return moduleName;
     }
 
-    ServiceProvider<Module> lookupThisModule(String name,
-                                             Services services) {
-        return services.lookupFirst(Module.class, name, false).orElseThrow(() -> noModuleFoundError(name));
+    ServiceProvider<ModuleComponent> lookupThisModule(String name,
+                                                      Services services) {
+        return services.lookupFirst(ModuleComponent.class, name, false).orElseThrow(() -> noModuleFoundError(name));
     }
 
     String getClassPrefixName() {
@@ -260,7 +260,9 @@ protected void innerExecute() {
             ApplicationCreator creator = applicationCreator();
 
             List<ServiceProvider<?>> allModules = services
-                    .lookupAll(DefaultServiceInfoCriteria.builder().addContractImplemented(Module.class.getName()).build());
+                    .lookupAll(DefaultServiceInfoCriteria.builder()
+                                       .addContractImplemented(ModuleComponent.class.getName())
+                                       .build());
             getLog().info("processing modules: " + toDescriptions(allModules));
             if (allModules.isEmpty()) {
                 warn("no modules to process");
@@ -284,7 +286,7 @@ protected void innerExecute() {
                     ? moduleInfoPathRef.get().getPath()
                     : null;
             String moduleInfoModuleName = getThisModuleName();
-            ServiceProvider<Module> moduleSp = lookupThisModule(moduleInfoModuleName, services);
+            ServiceProvider<ModuleComponent> moduleSp = lookupThisModule(moduleInfoModuleName, services);
             String packageName = determinePackageName(Optional.ofNullable(moduleSp), serviceTypeNames, descriptor, true);
 
             CodeGenPaths codeGenPaths = DefaultCodeGenPaths.builder()

pico/maven-plugin/src/main/java/io/helidon/pico/maven/plugin/AbstractCreatorMojo.java

@@ -26,7 +26,7 @@
 
 import io.helidon.common.types.DefaultTypeName;
 import io.helidon.common.types.TypeName;
-import io.helidon.pico.api.Module;
+import io.helidon.pico.api.ModuleComponent;
 import io.helidon.pico.api.PicoServicesConfig;
 import io.helidon.pico.api.ServiceProvider;
 import io.helidon.pico.tools.AbstractCreator;
@@ -264,7 +264,7 @@ public void execute() throws MojoExecutionException {
      * @param persistIt   pass true to write it to scratch, so that we can use it in the future for this module
      * @return the package name (which also typically doubles as the application name)
      */
-    protected String determinePackageName(Optional<ServiceProvider<Module>> optModuleSp,
+    protected String determinePackageName(Optional<ServiceProvider<ModuleComponent>> optModuleSp,
                                           Collection<TypeName> typeNames,
                                           ModuleInfoDescriptor descriptor,
                                           boolean persistIt) {
@@ -276,7 +276,7 @@ protected String determinePackageName(Optional<ServiceProvider<Module>> optModul
                 return packageName;
             }
 
-            ServiceProvider<Module> moduleSp = optModuleSp.orElse(null);
+            ServiceProvider<ModuleComponent> moduleSp = optModuleSp.orElse(null);
             if (moduleSp != null) {
                 packageName = DefaultTypeName.createFromTypeName(moduleSp.serviceInfo().serviceTypeName()).packageName();
             } else {

pico/maven-plugin/src/main/java/io/helidon/pico/maven/plugin/ExternalModuleCreatorMojo.java

@@ -51,7 +51,7 @@
 import static io.helidon.pico.maven.plugin.MavenPluginUtils.externalModuleCreator;
 
 /**
- * Responsible for creating pico {@link io.helidon.pico.api.Activator}'s and a {@link io.helidon.pico.api.Module}
+ * Responsible for creating pico {@link io.helidon.pico.api.Activator}'s and a {@link io.helidon.pico.api.ModuleComponent}
  * wrapping a set of packages from an external third-party jar.
  */
 @Mojo(name = "external-module-create", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true,