library/io.github.baole.konture/PropertyDeclarationShouldContext

PropertyDeclarationShouldContext

Context receiver for writing declarative assertions on a PropertyDeclarationContext element. Provides easy access to all element properties and custom helper assertions.

Properties

allProperties

val allProperties: List<PropertyDeclarationContext>

Filter or assertion criteria for all properties.

annotations

val annotations: List<AnnotationDeclaration>

Filter or assertion criteria for annotations.

className

val className: String?

Filter or assertion criteria for class name.

declaration

val declaration: PropertyDeclaration

Filter or assertion criteria for declaration.

element

val element: PropertyDeclarationContext

Filter or assertion criteria for element.

filePath

val filePath: String

Filter or assertion criteria for file path.

isExtension

val isExtension: Boolean

Filter or assertion criteria for is extension.

isVal

val isVal: Boolean

Filter or assertion criteria for is val.

isVar

val isVar: Boolean

Filter or assertion criteria for is var.

kdocText

val kdocText: String?

Filter or assertion criteria for kdoc text.

modifiers

val modifiers: Set<Modifier>

Filter or assertion criteria for modifiers.

modulePath

val modulePath: String

Filter or assertion criteria for module path.

name

val name: String

Filter or assertion criteria for name.

packageName

val packageName: String

Filter or assertion criteria for package name.

type

val type: String

Filter or assertion criteria for type.

violations

val violations: MutableList<String>

Filter or assertion criteria for violations.

visibility

val visibility: Visibility

Filter or assertion criteria for visibility.

Functions

addViolation

fun addViolation(message: String)

Appends a custom violation failure message to the assertion run.

assertAllAnnotationsOf

fun assertAllAnnotationsOf(vararg names: String)

fun assertAllAnnotationsOf(names: List<String>)

Asserts that this property is decorated with all of the specified annotations.

assertAnnotationOf

fun assertAnnotationOf(annotationName: String)

Asserts that this property is decorated with the specified annotation.

assertAnyAnnotationOf

fun assertAnyAnnotationOf(vararg names: String)

fun assertAnyAnnotationOf(names: List<String>)

Asserts that this property is decorated with at least one of the specified annotations.

check

fun check(condition: Boolean, message: String? = null)

Asserts condition is true, recording a violation with message when false. When message is omitted, a default message referencing element is used.

hasAllAnnotations

fun hasAllAnnotations(vararg names: String): Boolean

fun hasAllAnnotations(names: List<String>): Boolean

Checks if this property is decorated with all of the specified annotations.

hasAnnotation

fun hasAnnotation(name: String): Boolean

Checks if this property is decorated with the specified annotation.

hasAnyAnnotation

fun hasAnyAnnotation(vararg names: String): Boolean

fun hasAnyAnnotation(names: List<String>): Boolean

Checks if this property is decorated with any of the specified annotations.