library/io.github.baole.konture/ClassDeclarationShouldContext

ClassDeclarationShouldContext

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

Properties

allClasses

val allClasses: List<ClassDeclaration>

Filter or assertion criteria for all classes.

annotations

val annotations: List<AnnotationDeclaration>

Filter or assertion criteria for annotations.

companionObject

val companionObject: ClassDeclaration?

Filter or assertion criteria for companion object.

element

val element: ClassDeclaration

Filter or assertion criteria for element.

filePath

val filePath: String

Filter or assertion criteria for file path.

fqName

val fqName: String

Filter or assertion criteria for fq name.

functions

val functions: List<FunctionDeclaration>

Filter or assertion criteria for functions.

imports

val imports: List<String>

Filter or assertion criteria for imports.

isAbstract

val isAbstract: Boolean

Filter or assertion criteria for is abstract.

isInterface

val isInterface: Boolean

Filter or assertion criteria for is interface.

kdocText

val kdocText: String?

Filter or assertion criteria for kdoc text.

modifiers

val modifiers: Set<Modifier>

Filter or assertion criteria for modifiers.

name

val name: String

Filter or assertion criteria for name.

packageName

val packageName: String

Filter or assertion criteria for package name.

primaryConstructor

val primaryConstructor: ConstructorDeclaration?

Filter or assertion criteria for primary constructor.

properties

val properties: List<PropertyDeclaration>

Filter or assertion criteria for properties.

referencedTypes

val referencedTypes: Set<String>

Filter or assertion criteria for referenced types.

secondaryConstructors

val secondaryConstructors: List<ConstructorDeclaration>

Filter or assertion criteria for secondary constructors.

supertypes

val supertypes: List<String>

Filter or assertion criteria for supertypes.

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 class is decorated with all of the specified annotations.

assertAnnotationOf

fun assertAnnotationOf(annotationName: String)

Asserts that this class is decorated with the specified annotation.

assertAnyAnnotationOf

fun assertAnyAnnotationOf(vararg names: String)

fun assertAnyAnnotationOf(names: List<String>)

Asserts that this class 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 class is annotated with all of the given annotation names.

hasAnnotation

fun hasAnnotation(name: String): Boolean

Checks if this class is annotated with the given annotation name or fully qualified name.

hasAnyAnnotation

fun hasAnyAnnotation(vararg names: String): Boolean

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

Checks if this class is annotated with any of the given annotation names.