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

KoArgumentDeclaration

interface KoArgumentDeclaration : KoBaseDeclaration, KoBaseProvider, KoValueProvider, KoContainingFileProvider, KoLocationProvider, KoNameProvider, KoPackageProvider, KoContainingDeclarationProvider, KoPathProvider, KoModuleProvider, KoSourceSetProvider, KoResideInPackageProvider, KoTextProvider

Represents a Kotlin argument declaration.

Properties

containingDeclaration

abstract val containingDeclaration: KoBaseDeclaration

The parent of the declaration.

containingFile

abstract val containingFile: KoFileDeclaration

File containing 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.

name

abstract val name: String

Name of the declaration.

packagee

abstract val packagee: KoPackageDeclaration?

Package 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.

sourceSetName

abstract val sourceSetName: String

The declaration's source set name.

text

abstract val text: String

Text of the declaration.

value

abstract val value: String?

The value of declaration.

Functions

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.

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.

hasValue

abstract fun hasValue(value: String? = null): Boolean

Determines whatever the declaration has the value.

resideInModule

abstract fun resideInModule(name: String): Boolean

Determines whatever declaration reside in module.

resideInPackage

abstract fun resideInPackage(name: String): Boolean

Determines whatever the declaration resides in a package.

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.

resideOutsidePackage

abstract fun resideOutsidePackage(name: String): Boolean

Determines whatever the declaration resides outside a package.

toString

abstract override fun toString(): String

String representing the argument.