KoParameterDeclaration

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

Properties

annotations

abstract val annotations: List<KoAnnotationDeclaration>

List of annotations.

containingDeclaration

abstract val containingDeclaration: KoBaseDeclaration

The parent of the declaration.

containingFile

abstract val containingFile: KoFileDeclaration

File containing the declaration.

defaultValue

abstract val defaultValue: String?

Default value of the declaration.

hasCrossInlineModifier

abstract val hasCrossInlineModifier: Boolean

Determines whatever the declaration has crossinline modifier.

hasNoInlineModifier

abstract val hasNoInlineModifier: Boolean

Determines whatever the declaration has noinline modifier.

hasValModifier

abstract val ~~hasValModifier~~: Boolean

Determines whatever the declaration has val modifier.

hasVarArgModifier

abstract val hasVarArgModifier: Boolean

Determines whatever the declaration has vararg modifier.

hasVarModifier

abstract val ~~hasVarModifier~~: Boolean

Determines whatever the declaration has var modifier.

isVal

abstract val isVal: Boolean

Determines whatever the declaration has val keyword.

isVar

abstract val isVar: Boolean

Determines whatever the declaration has var keyword.

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

modifiers

abstract val modifiers: List<KoModifier>

List of modifiers.

moduleName

abstract val moduleName: String

The declaration's module name.

name

abstract val name: String

Name of the declaration.

numAnnotations

abstract val numAnnotations: Int

The number of annotations.

numModifiers

abstract val numModifiers: Int

The number of modifiers.

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.

type

abstract val type: KoTypeDeclaration

Type of the declaration.

Functions

countAnnotations

abstract fun countAnnotations(predicate: (KoAnnotationDeclaration) -> Boolean): Int

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

hasAllAnnotations

abstract fun hasAllAnnotations(predicate: (KoAnnotationDeclaration) -> Boolean): Boolean

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

hasAllAnnotationsOf

abstract fun hasAllAnnotationsOf(names: Collection<KClass<*>>): Boolean

abstract fun hasAllAnnotationsOf(name: KClass<*>, vararg names: KClass<*>): Boolean

Determines whether the declaration has annotations with all the specified KClass type.

hasAllModifiers

abstract fun hasAllModifiers(modifiers: Collection<KoModifier>): Boolean

abstract fun hasAllModifiers(modifier: KoModifier, vararg modifiers: KoModifier): Boolean

Determines whether the declaration has all specified modifiers.

hasAnnotation

abstract fun hasAnnotation(predicate: (KoAnnotationDeclaration) -> Boolean): Boolean

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

hasAnnotationOf

abstract fun hasAnnotationOf(names: Collection<KClass<*>>): Boolean

abstract fun hasAnnotationOf(name: KClass<*>, vararg names: KClass<*>): Boolean

Determines whether the declaration has at least one annotation of the specified KClass type.

hasAnnotationOf

inline fun <T> KoAnnotationProvider.hasAnnotationOf(): Boolean

Returns true if declaration represents the type of T.

hasAnnotations

abstract fun hasAnnotations(): Boolean

Determines whatever declaration has any annotation.

hasAnnotationsWithAllNames

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

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

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

hasAnnotationWithName

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

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

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

hasDefaultValue

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

Determines whatever the declaration ha the default value.

hasModifier

abstract fun hasModifier(modifiers: Collection<KoModifier>): Boolean

abstract fun hasModifier(modifier: KoModifier, vararg modifiers: KoModifier): Boolean

Determines whether the declaration has at least one specified modifier.

hasModifiers

abstract fun hasModifiers(): Boolean

Determines whatever the declaration has modifiers.

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.

hasType

abstract fun hasType(predicate: (KoTypeDeclaration) -> Boolean): Boolean

Determines whatever declaration has a specified type.

hasTypeOf

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

Determines whatever declaration has a type of the specified Kotlin class.

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.

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