org.koin.experimental.builder.ModuleExt.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of koin-core-ext Show documentation

KOIN - Kotlin simple Dependency Injection Framework

There is a newer version: 3.0.2

/*
 * Copyright 2017-2018 the original author or 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
 *
 *      http://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 org.koin.experimental.builder

import org.koin.core.definition.BeanDefinition
import org.koin.core.module.Module
import org.koin.core.qualifier.Qualifier

/**
 * Create a Single definition for given type T
 * @param qualifier
 * @param createOnStart - need to be created at start
 * @param override - allow definition override
 */
inline fun  Module.single(
        qualifier: Qualifier? = null,
        createOnStart: Boolean = false,
        override: Boolean = false
): BeanDefinition {
    return single(qualifier, createOnStart, override) { create(this) }
}

/**
 * Create a Factory definition for given type T
 *
 * @param qualifier
 * @param override - allow definition override
 */
inline fun  Module.factory(
        qualifier: Qualifier? = null,
        override: Boolean = false
): BeanDefinition {
    return factory(qualifier, override) { create(this) }
}

/**
 * Create a Single definition for given type T to modules and cast as R
 * @param qualifier
 * @param createOnStart - need to be created at start
 * @param override - allow definition override
 */
inline fun  Module.singleBy(
        qualifier: Qualifier? = null,
        createOnStart: Boolean = false,
        override: Boolean = false
): BeanDefinition {
    return single(qualifier, createOnStart, override) { create(this) as R }
}

/**
 * Create a Factory definition for given type T to modules and cast as R
 *
 * @param qualifier
 * @param override - allow definition override
 */
inline fun  Module.factoryBy(
        qualifier: Qualifier? = null,
        override: Boolean = false
): BeanDefinition {
    return factory(qualifier, override) { create(this) as R }
}