Konsist 0.17.0/com.lemonappdev.konsist.api.container/KoScope

KoScope

interface KoScope

Represents a scope of Kotlin declarations.

Properties

Link copied to clipboard
abstract val annotations: List<KoAnnotationDeclaration>

The annotations present in the scope.

Link copied to clipboard
abstract val files: List<KoFileDeclaration>

The files present in the scope.

Link copied to clipboard
abstract val imports: List<KoImportDeclaration>

The imports present in the scope.

Link copied to clipboard
abstract val packages: List<KoPackageDeclaration>

The packages present in the scope.

Link copied to clipboard
abstract val typeAliases: List<KoTypeAliasDeclaration>

The type aliases present in the scope.

Functions

Link copied to clipboard
open override fun KoScope.assertArchitecture(layerDependenciesFunc: LayerDependencies)

Asserts the architecture with the specified layerDependenciesFunc.

open override fun KoScope.assertArchitecture(layerDependenciesFunc: LayerDependencies.() -> Unit)

Asserts the architecture with the specified layerDependenciesFunc defined as a function literal with receiver LayerDependencies.

open override fun KoScope.assertArchitecture(additionalMessage: String?, testName: String?, layerDependenciesFunc: LayerDependencies)

Asserts the architecture with the specified layerDependenciesFunc.

open override fun KoScope.assertArchitecture(additionalMessage: String?, testName: String?, layerDependenciesFunc: LayerDependencies.() -> Unit)

Asserts the architecture with the specified layerDependenciesFunc defined as a function literal with receiver LayerDependencies.

Link copied to clipboard
abstract fun classes(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassDeclaration>

The classes present in the scope.

Link copied to clipboard
abstract fun classesAndInterfaces(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassAndInterfaceDeclaration>

The classes and interfaces present in the scope.

Link copied to clipboard
abstract fun classesAndInterfacesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassAndInterfaceAndObjectDeclaration>

The classes, interfaces and objects present in the scope.

Link copied to clipboard
abstract fun classesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassAndObjectDeclaration>

The classes and objects present in the scope.

Link copied to clipboard
abstract fun declarations(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoBaseDeclaration>

The declarations present in the scope.

Link copied to clipboard
inline fun <T : KoBaseProvider> KoScope.declarationsOf(includeNested: Boolean = true, includeLocal: Boolean = true): List<T>

The declarations of type T present in the scope.

Link copied to clipboard
abstract operator override fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

Link copied to clipboard
abstract fun functions(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoFunctionDeclaration>

The functions present in the scope.

Link copied to clipboard
abstract override fun hashCode(): Int

Returns a hash code value for the object.

Link copied to clipboard
abstract fun interfaces(includeNested: Boolean = true): List<KoInterfaceDeclaration>

The interfaces present in the scope.

Link copied to clipboard
abstract fun interfacesAndObjects(includeNested: Boolean = true): List<KoInterfaceAndObjectDeclaration>

The interface and objects present in the scope.

Link copied to clipboard
abstract operator fun minus(scope: KoScope): KoScope

Subtract scope files from this scope.

Link copied to clipboard
abstract operator fun minusAssign(scope: KoScope)

Subtract a scope files and create a new scope.

Link copied to clipboard
abstract fun objects(includeNested: Boolean = true): List<KoObjectDeclaration>

The objects present in the scope.

Link copied to clipboard
abstract operator fun plus(scope: KoScope): KoScope

Add a scope files to this scope.

Link copied to clipboard
abstract operator fun plusAssign(scope: KoScope)

Add a scope files and create a new scope.

Link copied to clipboard
abstract fun print(prefix: String? = null, predicate: (KoScope) -> String? = null): KoScope

Print the scope.

Link copied to clipboard
abstract fun properties(includeNested: Boolean = true): List<KoPropertyDeclaration>

The properties present in the scope.

Link copied to clipboard
abstract fun slice(predicate: (KoFileDeclaration) -> Boolean): KoScope

The scope with given predicate.

Link copied to clipboard
abstract override fun toString(): String

String representing the scope.