Konsist 0.17.0/com.lemonappdev.konsist.api.declaration/KoInitBlockDeclaration

KoInitBlockDeclaration

interface KoInitBlockDeclaration : KoBaseDeclaration, KoBaseProvider, KoLocalClassProvider, KoLocalDeclarationProvider, KoLocalFunctionProvider, KoVariableProvider, KoContainingFileProvider, KoLocationProvider, KoContainingDeclarationProvider, KoPathProvider, KoModuleProvider, KoSourceSetProvider, KoTextProvider

Represents a Kotlin init block declaration.

Properties

containingDeclaration

abstract val containingDeclaration: KoBaseDeclaration

The parent of the declaration.

containingFile

abstract val containingFile: KoFileDeclaration

File containing the declaration.

localClasses

abstract val localClasses: List<KoClassDeclaration>

The local classes present in the declaration.

localDeclarations

abstract val localDeclarations: List<KoBaseDeclaration>

The local declarations present in the declaration.

localFunctions

abstract val localFunctions: List<KoFunctionDeclaration>

The local functions present in the declaration.

location

abstract val location: String

Location of the declaration containing the file path, line and column.

locationWithText

abstract val locationWithText: String

Text of the declaration with the location (file path, line and column).

moduleName

abstract val moduleName: String

The declaration's module name.

numLocalClasses

abstract val numLocalClasses: Int

The number of local classes.

numLocalDeclarations

abstract val numLocalDeclarations: Int

The number of local declarations.

numLocalFunctions

abstract val numLocalFunctions: Int

The number of local functions.

numVariables

abstract val numVariables: Int

The number of variables.

path

abstract val path: String

File path of the declaration or path of the file.

projectPath

abstract val projectPath: String

Project file path of the declaration or root project path of the file.

sourceSetName

abstract val sourceSetName: String

The declaration's source set name.

text

abstract val text: String

Text of the declaration.

variables

abstract val variables: List<KoVariableDeclaration>

The variables present in the declaration.

Functions

countLocalClasses

abstract fun countLocalClasses(predicate: (KoClassDeclaration) -> Boolean): Int

Returns the number of local classes that satisfies the specified predicate present in the declaration.

countLocalDeclarations

abstract fun countLocalDeclarations(predicate: (KoBaseDeclaration) -> Boolean): Int

Returns the number of local declarations that satisfies the specified predicate present in the declaration.

countLocalFunctions

abstract fun countLocalFunctions(predicate: (KoFunctionDeclaration) -> Boolean): Int

Returns the number of local functions that satisfies the specified predicate present in the declaration.

countVariables

abstract fun countVariables(predicate: (KoVariableDeclaration) -> Boolean): Int

Gets the number of variables that satisfies the specified predicate present in the declaration.

hasAllLocalClasses

abstract fun hasAllLocalClasses(predicate: (KoClassDeclaration) -> Boolean): Boolean

Determines whether the declaration has all local classes that satisfy the provided predicate.

hasAllLocalDeclarations

abstract fun hasAllLocalDeclarations(predicate: (KoBaseDeclaration) -> Boolean): Boolean

Determines whether the declaration has all local declarations that satisfy the provided predicate.

hasAllLocalFunctions

abstract fun hasAllLocalFunctions(predicate: (KoFunctionDeclaration) -> Boolean): Boolean

Determines whether the declaration has all local functions that satisfy the provided predicate.

hasAllVariables

abstract fun hasAllVariables(predicate: (KoVariableDeclaration) -> Boolean): Boolean

Determines whether the declaration has all variables that satisfy the provided predicate.

hasLocalClass

abstract fun hasLocalClass(predicate: (KoClassDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one local class that satisfies the provided predicate.

hasLocalClasses

abstract fun hasLocalClasses(): Boolean

Determines whatever the declaration has local classes.

hasLocalClassesWithAllNames

abstract fun hasLocalClassesWithAllNames(names: Collection<String>): Boolean

abstract fun hasLocalClassesWithAllNames(name: String, vararg names: String): Boolean

Determines whether the declaration has local classes with all the specified names.

hasLocalClassWithName

abstract fun hasLocalClassWithName(names: Collection<String>): Boolean

abstract fun hasLocalClassWithName(name: String, vararg names: String): Boolean

Determines whether the declaration has at least one local class whose name matches any of the specified names.

hasLocalDeclaration

abstract fun hasLocalDeclaration(predicate: (KoBaseDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one local declaration that satisfies the provided predicate.

hasLocalDeclarations

abstract fun hasLocalDeclarations(): Boolean

Determines whatever the declaration has local declarations.

hasLocalFunction

abstract fun hasLocalFunction(predicate: (KoFunctionDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one local function that satisfies the provided predicate.

hasLocalFunctions

abstract fun hasLocalFunctions(): Boolean

Determines whatever the declaration has local functions.

hasLocalFunctionsWithAllNames

abstract fun hasLocalFunctionsWithAllNames(names: Collection<String>): Boolean

abstract fun hasLocalFunctionsWithAllNames(name: String, vararg names: String): Boolean

Determines whether the declaration has local functions with all the specified names.

hasLocalFunctionWithName

abstract fun hasLocalFunctionWithName(names: Collection<String>): Boolean

abstract fun hasLocalFunctionWithName(name: String, vararg names: String): Boolean

Determines whether the declaration has at least one local function whose name matches any of the specified names.

hasTextContaining

abstract fun hasTextContaining(str: String): Boolean

Text of the declaration containing text.

hasTextEndingWith

abstract fun hasTextEndingWith(suffix: String): Boolean

Text of the declaration with suffix.

hasTextMatching

abstract fun hasTextMatching(regex: Regex): Boolean

Text of the declaration matching regex.

hasTextStartingWith

abstract fun hasTextStartingWith(prefix: String): Boolean

Text of the declaration with prefix.

hasVariable

abstract fun hasVariable(predicate: (KoVariableDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one variable that satisfies the provided predicate.

hasVariables

abstract fun hasVariables(): Boolean

Whether the declaration has variables.

hasVariablesWithAllNames

abstract fun hasVariablesWithAllNames(names: Collection<String>): Boolean

abstract fun hasVariablesWithAllNames(name: String, vararg names: String): Boolean

Determines whether the declaration has variables with all the specified names.

hasVariableWithName

abstract fun hasVariableWithName(names: Collection<String>): Boolean

abstract fun hasVariableWithName(name: String, vararg names: String): Boolean

Determines whether the declaration has at least one variable whose name matches any of the specified names.

resideInModule

abstract fun resideInModule(name: String): Boolean

Determines whatever declaration reside in module.

resideInPath

abstract fun resideInPath(path: String, absolutePath: Boolean = false): Boolean

Determines whatever declaration reside in file path or file reside in path.

resideInSourceSet

abstract fun resideInSourceSet(sourceSetName: String): Boolean

Determines whatever declaration reside in source set.

toString

abstract override fun toString(): String

String representing the declaration.