library/io.github.baole.konture/FunctionDeclarationContext

FunctionDeclarationContext

data class FunctionDeclarationContext(val declaration: FunctionDeclaration, val packageName: String, val className: String?, val modulePath: String, val filePath: String, val sourceSet: SourceSetId? = null, val usages: List<SourceUsage> = emptyList())

Context wrapper for verifying function declarations.

Provides both the target declaration and architectural metadata to easily query scope.

Constructors

constructor(declaration: FunctionDeclaration, packageName: String, className: String?, modulePath: String, filePath: String, sourceSet: SourceSetId? = null, usages: List<SourceUsage> = emptyList())

Properties

annotations

val FunctionDeclarationContext.annotations: List<AnnotationDeclaration>

Delegates annotations property to the underlying FunctionDeclaration.

className

val className: String?

Filter or assertion criteria for class name.

declaration

val declaration: FunctionDeclaration

Filter or assertion criteria for declaration.

filePath

val filePath: String

Filter or assertion criteria for file path.

isExtension

val FunctionDeclarationContext.isExtension: Boolean

Delegates isExtension property to the underlying FunctionDeclaration.

kdocText

val FunctionDeclarationContext.kdocText: String?

Delegates kdocText property to the underlying FunctionDeclaration.

modifiers

val FunctionDeclarationContext.modifiers: Set<Modifier>

Delegates modifiers property to the underlying FunctionDeclaration.

modulePath

val modulePath: String

Filter or assertion criteria for module path.

name

val FunctionDeclarationContext.name: String

Delegates name property to the underlying FunctionDeclaration.

packageName

val packageName: String

Filter or assertion criteria for package name.

parameters

val FunctionDeclarationContext.parameters: List<ParameterDeclaration>

Delegates parameters property to the underlying FunctionDeclaration.

qualifiedName

val qualifiedName: String

The fully-qualified name of the function, combining package, enclosing class (if any), and simple name (e.g. com.acme.UserService.getUser), used to identify it unambiguously in violation messages.

returnType

val FunctionDeclarationContext.returnType: String

Delegates returnType property to the underlying FunctionDeclaration.

sourceSet

val sourceSet: SourceSetId? = null

Filter or assertion criteria for source set.

usages

val usages: List<SourceUsage>

Filter or assertion criteria for usages.

visibility

val FunctionDeclarationContext.visibility: Visibility

Delegates visibility property to the underlying FunctionDeclaration.