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

KoImportDeclaration

interface KoImportDeclaration : KoBaseDeclaration, KoBaseProvider, KoAliasProvider, KoContainingFileProvider, KoLocationProvider, KoMatchesProvider, KoNameProvider, KoPathProvider, KoModuleProvider, KoSourceSetProvider, KoTextProvider, KoWildcardProvider, KoIsWildcardProvider, KoRepresentsTypeProvider, KoSourceDeclarationProvider

Represents a Kotlin import declaration.

Properties

alias

abstract val alias: KoImportAliasDeclaration?

Alias of the declaration.

containingFile

abstract val containingFile: KoFileDeclaration

File containing the declaration.

isWildcard

abstract val isWildcard: Boolean

Determines whatever this declaration is a wildcard.

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.

name

abstract val name: String

Name of the declaration.

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.

sourceDeclaration

abstract val sourceDeclaration: KoDeclarationCastProvider?

Represents the source declaration associated with this type.

sourceSetName

abstract val sourceSetName: String

The declaration's source set name.

text

abstract val text: String

Text of the declaration.

Functions

hasAlias

abstract fun hasAlias(predicate: (KoImportAliasDeclaration) -> Boolean? = null): Boolean

Determines whatever declaration has a specified alias.

hasNameContaining

abstract fun hasNameContaining(text: String): Boolean

Name of the declaration containing text.

hasNameEndingWith

abstract fun hasNameEndingWith(suffix: String): Boolean

Name of the declaration with suffix.

hasNameMatching

abstract fun hasNameMatching(regex: Regex): Boolean

Name of the declaration matching regex.

hasNameStartingWith

abstract fun hasNameStartingWith(prefix: String): Boolean

Name of the declaration with prefix.

hasSourceDeclaration

abstract fun hasSourceDeclaration(predicate: (KoDeclarationCastProvider) -> Boolean): Boolean

Determines whatever type has a specified source declaration.

hasSourceDeclarationOf

abstract fun hasSourceDeclarationOf(kClass: KClass<*>): Boolean

Whether type has a source declaration of the specified Kotlin class.

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.

matches

abstract fun matches(element: String): Boolean

Determines whether the given element matches to declaration.

representsType

abstract fun representsType(name: String?): Boolean

Determines whatever this declaration represents the specified type.

representsTypeOf

inline fun <T> KoRepresentsTypeProvider.representsTypeOf(): Boolean

Returns true if declaration represents the type of T.

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.