Determines whether the source declaration is a star projection. A star projection is a placeholder that represents any type in a generic context, allowing for flexible type constraints.

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.

name

abstract val name: String

Name of the declaration.

numModifiers

abstract val numModifiers: Int

The number of modifiers.

numParameters

abstract val numParameters: Int

The number of parameters for the function type.

numParameterTypes

abstract val ~~numParameterTypes~~: Int

The number of parameters for the function type.

numTypeArguments

abstract val numTypeArguments: Int

The number of type arguments.

parameters

abstract val parameters: List<KoParameterDeclaration>?

Represents the parameters of the function type.

parameterTypes

abstract val ~~parameterTypes~~: List<KoParameterDeclaration>?

Represents the parameters of the function type.

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.

returnType

abstract val returnType: KoTypeDeclaration?

Represents the return type of the function type.

sourceDeclaration

abstract val sourceDeclaration: KoDeclarationCastProvider?

Represents the source declaration associated with this type.

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

countParameters

abstract fun countParameters(predicate: (KoParameterDeclaration) -> Boolean): Int

Counts the number of parameters that match the given predicate.

countParameterTypes

abstract fun ~~countParameterTypes~~(predicate: (KoParameterDeclaration) -> Boolean): Int

Counts the number of parameter types that match the given predicate.

countTypeArguments

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

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

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.

hasAllParameters

abstract fun hasAllParameters(predicate: (KoParameterDeclaration) -> Boolean): Boolean

Checks if all parameters match the given predicate.

hasAllParameterTypes

abstract fun ~~hasAllParameterTypes~~(predicate: (KoParameterDeclaration) -> Boolean): Boolean

Checks if all parameter types match the given 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.

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.

hasParameter

abstract fun hasParameter(predicate: (KoParameterDeclaration) -> Boolean): Boolean

Checks if any parameter matches the given predicate.

hasParameterType

abstract fun ~~hasParameterType~~(predicate: (KoParameterDeclaration) -> Boolean): Boolean

Checks if any parameter type matches the given predicate.

hasReturnType

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

Checks if the return type matches the given predicate.

hasReturnTypeOf

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

Checks if the return type matches the specified class.

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.

resideInPath

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

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

toString

abstract override fun toString(): String

String representing the declaration.