se.ansman.dagger.auto.AutoBindIntoMap.kt Maven / Gradle / Ivy

Go to download
package se.ansman.dagger.auto

import dagger.MapKey
import dagger.hilt.GeneratesRootInput
import dagger.multibindings.IntoMap
import dagger.multibindings.StringKey
import kotlin.reflect.KClass

/**
 * A version of [AutoBind] that binds the object using [IntoMap].
 * The object must also be annotated with a [MapKey] annotated annotation such as [StringKey], [MapKey], or
 * a custom annotation.
 *
 * For more documentation on auto bind see [AutoBind].
 *
 * See also [Map Multibindings][https://dagger.dev/dev-guide/multibindings.html#map-multibindings]
 *
 * @param inComponent Which component to install the binding in. Defaults to being inferred based on the scope.
 * @param asTypes Specifies which supertypes to bind the object as. Required if there are multiple supertypes.
 * @param bindGenericAs Specifies how generic supertypes should be bound. Defaults to [BindGenericAs.ExactType] or if the
 *   target type is annotated with [BindGenericAs.Default].
 * @see AutoBind
 * @see AutoBindIntoSet
 * @see BindGenericAs
 * @see BindGenericAs.Default
 * @see MapKey
 * @see IntoMap
 * @since 1.0.0
 */
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.BINARY)
@GeneratesRootInput
public annotation class AutoBindIntoMap(
    val inComponent: KClass<*> = Nothing::class,
    val asTypes: Array> = [],
    val bindGenericAs: BindGenericAs = BindGenericAs.ExactType,
)