runtime/dev.zacsweers.metro/ContributesBinding

ContributesBinding

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ContributesBinding(val scope: KClass<*>, val binding: binding<*> = binding<Nothing>(), val replaces: Array<KClass<*>> = [], val priority: Int = Int.MIN_VALUE)(source)

Contributes a binding of the annotated type to the given scope as a binding (if specified) or single declared supertype.

// Implicit supertype is Base
@ContributesBinding(AppScope::class)
@Inject
class Impl : Base

Use binding to specify a specific bound type if an implicit one is not possible.

// Explicit supertype is Base
@ContributesBinding(AppScope::class, binding = binding<Base>())
@Inject
class Impl : Base, AnotherBase

This annotation is repeatable, allowing the annotated type to contribute to multiple scopes, as multiple bound types, or both.

If this declaration is scoped, the Scope annotation will be propagated to the generated Binds declaration.

If this declaration is qualified, the Qualifier annotation will be propagated to the generated Binds declaration.

Properties

binding

val binding: binding<*>

The explicit bound type for this contribution, if not using the implicit supertype.

priority

val priority: Int

The priority of this binding relative to other contributions for the same qualified bound type. The highest-priority contribution is used. Contributions with the same priority remain duplicate bindings. Defaults to Int.MIN_VALUE.

replaces

val replaces: Array<KClass<*>>

List of other contributing classes that this binding should replace in the scope.

scope

val scope: KClass<*>

The scope this binding contributes to.