Make application component Factory a nested interface

deliveryhero · Jan 10, 2022 · 05eb985 · 05eb985
1 parent d6afb3f
commit 05eb985
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/whetstone/src/main/java/com/deliveryhero/whetstone/component/ApplicationComponent.kt b/whetstone/src/main/java/com/deliveryhero/whetstone/component/ApplicationComponent.kt
@@ -16,11 +16,11 @@ import javax.inject.Singleton
 @Singleton
 public interface ApplicationComponent {
     public fun getMembersInjectorMap(): MembersInjectorMap
-}
 
-/**
- * Interface for creating an [ApplicationComponent].
- */
-public interface ApplicationComponentFactory {
-    public fun create(@BindsInstance application: Application): ApplicationComponent
+    /**
+     * Interface for creating an [ApplicationComponent].
+     */
+    public interface Factory {
+        public fun create(@BindsInstance application: Application): ApplicationComponent
+    }
 }
diff --git a/whetstone/src/main/java/com/deliveryhero/whetstone/component/ApplicationComponentOwner.kt b/whetstone/src/main/java/com/deliveryhero/whetstone/component/ApplicationComponentOwner.kt
@@ -1,5 +1,12 @@
 package com.deliveryhero.whetstone.component
 
+/**
+ * Interface that should be implemented by the [android.app.Application] to supply
+ * the instance of the root [ApplicationComponent].
+ *
+ * It's strongly recommended that [applicationComponent] always returns the same
+ * instance across multiple invocations.
+ */
 public interface ApplicationComponentOwner {
 
     public val applicationComponent: ApplicationComponent