io.micronaut.kotlin.inject.QualifiersExtensions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-kotlin-extension-functions Show documentation

Includes extensions to Micronaut for Kotlin

There is a newer version: 4.4.0

Show newest version

/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.kotlin.inject

import io.micronaut.context.Qualifier
import io.micronaut.core.annotation.AnnotationMetadata
import io.micronaut.inject.qualifiers.Qualifiers

/**
 *  Top level function acting as a Kotlin shortcut allowing to write `qualifierByAnnotation(metadata)`
 *  instead of `Qualifiers.byAnnotation(metadata, Bar::class.java)`.
 *
 * @param T The component type
 * @param Q The stereotype type
 * @param metadata The metadata
 * @return The [Qualifier]
 * @author Alejandro Gomez
 * @since 1.0.0
 */
inline fun  qualifierByAnnotation(metadata: AnnotationMetadata): Qualifier =
        Qualifiers.byAnnotation(metadata, Q::class.java)

/**
 *  Top level function acting as a Kotlin shortcut allowing to write `qualifierByStereotype()`
 *  instead of `Qualifiers.byStereotype(Bar::class.java)`.
 *
 * @param T The component type
 * @param Q The stereotype type
 * @return The [Qualifier]
 * @author Alejandro Gomez
 * @since 1.0.0
 */
inline fun  qualifierByStereotype(): Qualifier = Qualifiers.byStereotype(Q::class.java)

/**
 *  Top level function acting as a Kotlin shortcut allowing to write `qualifierByStereotype(string)`
 *  instead of `Qualifiers.byStereotype(string)`.
 *
 * @param T The component type
 * @param name The stereotype name
 * @return The [Qualifier]
 * @author James Kleeh
 * @since 3.0.0
 */
inline fun  qualifierByStereotype(name: String): Qualifier = Qualifiers.byStereotype(name)

/**
 *  Top level function acting as a Kotlin shortcut allowing to write `qualifierByName(name)`
 *  instead of `Qualifiers.byStereotype(Bar::class.java)`.
 *
 * @param T The component type
 * @param name The name
 * @return The [Qualifier]
 * @author Luiz Picanço
 * @since 2.1.2
 */
inline fun  qualifierByName(name: String): Qualifier = Qualifiers.byName(name)