io.github.graphglue.model.property.LazyLoadingDelegate.kt Maven / Gradle / Ivy

Go to download

package io.github.graphglue.model.property

import io.github.graphglue.model.Node

/**
 * Delegate which can be called to get the loaded property
 *
 * @param T the type of Node stored in this property
 * @param R the type of property
 */
interface LazyLoadingDelegate {
    /**
     * Gets the loaded property
     *
     * @param cache used to load nodes from, if provided, not loading deleted nodes
     * @param loader if provided used to define nested nodes to load
     * @return the loaded property
     */
    suspend operator fun invoke(
        cache: NodeCache? = null, loader: (LazyLoadingSubqueryGenerator.() -> Unit)? = null
    ): R
}