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

KoParentDeclaration

interface KoParentDeclaration : KoBaseDeclaration, KoBaseProvider, KoNameProvider, KoPackageProvider, KoResideInPackageProvider, KoSourceDeclarationProvider, KoTypeArgumentProvider, KoTextProvider, KoContainingFileProvider, KoContainingDeclarationProvider, KoPathProvider, KoLocationProvider, KoAnnotationProvider, KoModuleProvider, KoSourceSetProvider, KoArgumentProvider, KoInterfaceDelegateProvider

Represents a Kotlin parent declaration.

Properties

annotations

abstract val annotations: List<KoAnnotationDeclaration>

List of annotations.

arguments

abstract val arguments: List<KoArgumentDeclaration>

List of arguments.

containingDeclaration

abstract val containingDeclaration: KoBaseDeclaration

The parent of the declaration.

containingFile

abstract val containingFile: KoFileDeclaration

File containing the declaration.

delegateName

abstract val delegateName: String?

Name of the delegate.

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.

numAnnotations

abstract val numAnnotations: Int

The number of annotations.

numArguments

abstract val numArguments: Int

The number of arguments.

numTypeArguments

abstract val numTypeArguments: Int

The number of type arguments.

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.

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.

typeArguments

abstract val typeArguments: List<KoTypeArgumentDeclaration>?

A list of type arguments associated with this declaration, if any. If there are no type arguments, this returns null.

Functions

countAnnotations

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

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

countArguments

abstract fun countArguments(predicate: (KoArgumentDeclaration) -> Boolean): Int

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

countTypeArguments

abstract fun countTypeArguments(predicate: (KoTypeArgumentDeclaration) -> Boolean): Int

Counts the number of type arguments that match the given predicate.

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.

hasAllArguments

abstract fun hasAllArguments(predicate: (KoArgumentDeclaration) -> Boolean): Boolean

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

hasAllTypeArguments

abstract fun hasAllTypeArguments(predicate: (KoTypeArgumentDeclaration) -> Boolean): Boolean

Checks if all type arguments match the given predicate.

hasAllTypeArgumentsOf

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

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

Checks if all type arguments match the specified class.

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.

hasArgument

abstract fun hasArgument(predicate: (KoArgumentDeclaration) -> Boolean): Boolean

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

hasArguments

abstract fun hasArguments(): Boolean

Determines whatever the declaration has arguments.

hasArgumentsWithAllNames

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

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

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

hasArgumentWithName

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

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

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

hasDelegate

abstract fun hasDelegate(delegateName: String? = null): Boolean

Determines whatever declaration has a delegate with given name.

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.

hasTypeArgument

abstract fun hasTypeArgument(predicate: (KoTypeArgumentDeclaration) -> Boolean): Boolean

Checks if any type argument matches the given predicate.

hasTypeArgumentOf

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

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

Checks if any type argument is of the specified class.

hasTypeArguments

abstract fun hasTypeArguments(): Boolean

Determines whatever the declaration has type arguments.

hasTypeArgumentsWithAllNames

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

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

Checks if all type arguments have one of the specified names.

hasTypeArgumentWithName

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

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

Checks if any type argument has one of the specified names.

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.