annotations/com.squareup.anvil.annotations/MergeComponent

MergeComponent

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class MergeComponent(val scope: KClass<*>, val modules: Array<KClass<*>> = [], val dependencies: Array<KClass<*>> = [], val exclude: Array<KClass<*>> = [])

Dagger components that should automatically include Dagger modules and component interfaces for the given scope require this annotation instead of @Component. The Kotlin compiler plugin will add the @Component annotation to this interface. The parameters modules and dependencies are preserved in the @Component annotation.

@MergeComponent(AppScope::class)
interface AppComponent

It's possible to exclude any automatically added Dagger module or component interface with the exclude parameter if needed.

@MergeComponent(
    scope = AppScope::class,
    exclude = [
      DaggerModule::class,
      ComponentInterface::class
    ]
)
interface AppComponent

Types

Builder

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Builder

Mirrors dagger.Component.Builder and just conveys that this annotated builder should be mirrored in the merged component class.

Factory

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Factory

Mirrors dagger.Component.Factory and just conveys that this annotated factory should be mirrored in the merged component class.

Properties

dependencies

val dependencies: Array<KClass<*>>

List of types that are to be used as component dependencies.

exclude

val exclude: Array<KClass<*>>

List of bindings, multibindings, modules and component interfaces that are contributed to the same scope, but should be excluded from the component.

modules

val modules: Array<KClass<*>>

List of Dagger modules that should be manually included in the component and aren't automatically contributed.

scope

val scope: KClass<*>

The scope used to find all contributed bindings, multibindings, modules and component interfaces, which should be included in this component.