library/io.github.baole.konture/PropertiesShould

PropertiesShould

class PropertiesShould : PropertiesShouldModifierAssertions, PropertiesShouldTypeAssertions, PropertiesShouldDependencyAssertions, PropertiesShouldCompositeAssertions

Assertion builder for checking rule expectations on Kotlin property declarations.

Properties

builder

open override val builder: PropertiesRuleBuilder

Filter or assertion criteria for builder.

Functions

allOf

open fun allOf(vararg blocks: PropertiesShould.() -> Unit): PropertiesRuleBuilder

Filter or assertion criteria for all of.

anyOf

open fun anyOf(vararg blocks: PropertiesShould.() -> Unit): PropertiesRuleBuilder

Asserts that selected properties satisfy at least one of the specified assertion blocks.

beAbstract

open fun beAbstract(): PropertiesRuleBuilder

Filter or assertion criteria for be abstract.

beAnnotatedWith

inline fun <T : Annotation> PropertiesShould.beAnnotatedWith(): PropertiesRuleBuilder

Asserts that properties are annotated with annotation type parameter T.

infix fun PropertiesShould.beAnnotatedWith(annotation: KClass<out Annotation>): PropertiesRuleBuilder

Asserts that properties are annotated with annotation.

beConst

open fun beConst(): PropertiesRuleBuilder

Filter or assertion criteria for be const.

beDocumentedWithKDoc

open fun beDocumentedWithKDoc(): PropertiesRuleBuilder

Filter or assertion criteria for be documented with k doc.

beExtension

open fun beExtension(): PropertiesRuleBuilder

Filter or assertion criteria for be extension.

beInternal

open fun beInternal(): PropertiesRuleBuilder

Filter or assertion criteria for be internal.

beLateinit

open fun beLateinit(): PropertiesRuleBuilder

Filter or assertion criteria for be lateinit.

beMember

open fun beMember(): PropertiesRuleBuilder

Filter or assertion criteria for be member.

beOpen

open fun beOpen(): PropertiesRuleBuilder

Filter or assertion criteria for be open.

beOverride

open fun beOverride(): PropertiesRuleBuilder

Filter or assertion criteria for be override.

bePrivate

open fun bePrivate(): PropertiesRuleBuilder

Filter or assertion criteria for be private.

beProtected

open fun beProtected(): PropertiesRuleBuilder

Filter or assertion criteria for be protected.

bePublic

open fun bePublic(): PropertiesRuleBuilder

Filter or assertion criteria for be public.

beTopLevel

open fun beTopLevel(): PropertiesRuleBuilder

Filter or assertion criteria for be top level.

beVal

open fun beVal(): PropertiesRuleBuilder

Filter or assertion criteria for be val.

beVar

open fun beVar(): PropertiesRuleBuilder

Filter or assertion criteria for be var.

dependOnPackageOf

open fun dependOnPackageOf(vararg classes: KClass<*>): PropertiesRuleBuilder

Asserts that selected properties depend on package containing classes.

dependOnPackageOf

inline fun <T : Any> PropertiesShould.dependOnPackageOf(): PropertiesRuleBuilder

Asserts that properties depend on package of T.

dependOnPackages

open fun dependOnPackages(vararg patterns: String): PropertiesRuleBuilder

open infix fun dependOnPackages(patterns: List<String>): PropertiesRuleBuilder

Asserts that selected properties depend on types or usages in packages matching patterns.

haveAllAnnotationsOf

open fun haveAllAnnotationsOf(vararg names: String): PropertiesRuleBuilder

open infix fun haveAllAnnotationsOf(names: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have all annotations of.

haveAllAnnotationsOf

fun PropertiesShould.haveAllAnnotationsOf(vararg annotations: KClass<out Annotation>): PropertiesRuleBuilder

Asserts that properties have all of the specified annotations.

haveAllModifiers

open fun haveAllModifiers(vararg modifiers: Modifier): PropertiesRuleBuilder

open infix fun haveAllModifiers(modifiers: List<Modifier>): PropertiesRuleBuilder

Filter or assertion criteria for have all modifiers.

haveAnnotationOf

open fun haveAnnotationOf(vararg annotationNames: String): PropertiesRuleBuilder

open infix fun haveAnnotationOf(annotationFqName: String): PropertiesRuleBuilder

open infix fun haveAnnotationOf(annotationNames: List<String>): PropertiesRuleBuilder

open infix fun haveAnnotationOf(annotation: KClass<out Annotation>): PropertiesRuleBuilder

Filter or assertion criteria for have annotation of.

haveAnnotationOf

infix fun PropertiesShould.haveAnnotationOf(annotation: KClass<out Annotation>): PropertiesRuleBuilder

Asserts that properties have the specified annotation class.

haveAnnotationOfType

inline fun <T : Annotation> PropertiesShould.haveAnnotationOfType(): PropertiesRuleBuilder

Asserts that properties have annotation type parameter T.

haveAnnotationWithArgument

open fun haveAnnotationWithArgument(annotationName: String, argName: String? = null, argValue: String): PropertiesRuleBuilder

Filter or assertion criteria for have annotation with argument.

haveAnnotationWithArgument

fun PropertiesShould.haveAnnotationWithArgument(annotation: KClass<out Annotation>, argName: String?, argValue: String): PropertiesRuleBuilder

Asserts that properties have an annotation annotation with argument argName equal to argValue.

haveAnyAnnotationOf

open fun haveAnyAnnotationOf(vararg names: String): PropertiesRuleBuilder

open infix fun haveAnyAnnotationOf(names: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have any annotation of.

haveAnyAnnotationOf

fun PropertiesShould.haveAnyAnnotationOf(vararg annotations: KClass<out Annotation>): PropertiesRuleBuilder

Asserts that properties have any of the specified annotations.

haveAnyModifier

open fun haveAnyModifier(vararg modifiers: Modifier): PropertiesRuleBuilder

open infix fun haveAnyModifier(modifiers: List<Modifier>): PropertiesRuleBuilder

Filter or assertion criteria for have any modifier.

haveAnyVisibility

open fun haveAnyVisibility(vararg visibilities: Visibility): PropertiesRuleBuilder

open infix fun haveAnyVisibility(visibilities: List<Visibility>): PropertiesRuleBuilder

Filter or assertion criteria for have any visibility.

haveImportOf

open infix fun haveImportOf(importFqName: String): PropertiesRuleBuilder

open infix fun haveImportOf(type: KClass<*>): PropertiesRuleBuilder

Filter or assertion criteria for have import of.

haveImportOf

inline fun <T : Any> PropertiesShould.haveImportOf(): PropertiesRuleBuilder

Asserts that properties have an import of type parameter T.

haveModifier

open infix fun haveModifier(modifier: Modifier): PropertiesRuleBuilder

open fun haveModifier(vararg modifiers: Modifier): PropertiesRuleBuilder

open infix fun haveModifier(modifiers: List<Modifier>): PropertiesRuleBuilder

Filter or assertion criteria for have modifier.

haveName

open fun haveName(vararg names: String): PropertiesRuleBuilder

open infix fun haveName(predicate: (String) -> Boolean): PropertiesRuleBuilder

open infix fun haveName(name: String): PropertiesRuleBuilder

open infix fun haveName(names: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have name.

haveNameEndingWith

open fun haveNameEndingWith(vararg suffixes: String): PropertiesRuleBuilder

open infix fun haveNameEndingWith(suffix: String): PropertiesRuleBuilder

open infix fun haveNameEndingWith(suffixes: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have name ending with.

haveNameMatching

open fun haveNameMatching(vararg patterns: String): PropertiesRuleBuilder

open infix fun haveNameMatching(pattern: String): PropertiesRuleBuilder

open infix fun haveNameMatching(patterns: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have name matching.

haveNameStartingWith

open fun haveNameStartingWith(vararg prefixes: String): PropertiesRuleBuilder

open infix fun haveNameStartingWith(prefix: String): PropertiesRuleBuilder

open infix fun haveNameStartingWith(prefixes: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have name starting with.

haveNoWildcardImports

open fun haveNoWildcardImports(): PropertiesRuleBuilder

Filter or assertion criteria for have no wildcard imports.

haveType

open fun haveType(vararg typeFqNames: String): PropertiesRuleBuilder

open infix fun haveType(typeFqName: String): PropertiesRuleBuilder

open infix fun haveType(typeFqNames: List<String>): PropertiesRuleBuilder

open infix fun haveType(type: KClass<*>): PropertiesRuleBuilder

Filter or assertion criteria for have type.

haveTypeIn

open fun haveTypeIn(vararg typeFqNames: String): PropertiesRuleBuilder

open infix fun haveTypeIn(typeFqNames: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for have type in.

haveTypeOf

inline fun <T : Any> PropertiesShould.haveTypeOf(): PropertiesRuleBuilder

Asserts that properties have type specified by type parameter T.

haveVisibility

open infix fun haveVisibility(visibility: Visibility): PropertiesRuleBuilder

Filter or assertion criteria for have visibility.

noneOf

open fun noneOf(vararg blocks: PropertiesShould.() -> Unit): PropertiesRuleBuilder

Filter or assertion criteria for none of.

notBeConst

open fun notBeConst(): PropertiesRuleBuilder

Filter or assertion criteria for not be const.

notBeExtension

open fun notBeExtension(): PropertiesRuleBuilder

Filter or assertion criteria for not be extension.

notBeInternal

open fun notBeInternal(): PropertiesRuleBuilder

Filter or assertion criteria for not be internal.

notBeLateinit

open fun notBeLateinit(): PropertiesRuleBuilder

Filter or assertion criteria for not be lateinit.

notBePrivate

open fun notBePrivate(): PropertiesRuleBuilder

Filter or assertion criteria for not be private.

notBeProtected

open fun notBeProtected(): PropertiesRuleBuilder

Filter or assertion criteria for not be protected.

notBePublic

open fun notBePublic(): PropertiesRuleBuilder

Filter or assertion criteria for not be public.

notCall

open fun notCall(fqName: String): PropertiesRuleBuilder

open fun notCall(kClass: KClass<*>): PropertiesRuleBuilder

Filter or assertion criteria for not call.

notCall

inline fun <T : Any> PropertiesShould.notCall(): PropertiesRuleBuilder

Asserts that properties do not call members of type parameter T.

notDependOnPackageOf

open fun notDependOnPackageOf(vararg classes: KClass<*>): PropertiesRuleBuilder

Asserts that selected properties do not depend on package containing classes.

notDependOnPackageOf

inline fun <T : Any> PropertiesShould.notDependOnPackageOf(): PropertiesRuleBuilder

Asserts that properties do not depend on package of T.

notDependOnPackages

open fun notDependOnPackages(vararg patterns: String): PropertiesRuleBuilder

open infix fun notDependOnPackages(patterns: List<String>): PropertiesRuleBuilder

Asserts that selected properties do not depend on types or usages in packages matching patterns.

notHaveImportOf

open infix fun notHaveImportOf(importFqName: String): PropertiesRuleBuilder

open infix fun notHaveImportOf(type: KClass<*>): PropertiesRuleBuilder

Filter or assertion criteria for not have import of.

notHaveImportOf

inline fun <T : Any> PropertiesShould.notHaveImportOf(): PropertiesRuleBuilder

Asserts that properties do not have an import of type parameter T.

notHaveName

open fun notHaveName(vararg names: String): PropertiesRuleBuilder

open infix fun notHaveName(name: String): PropertiesRuleBuilder

open infix fun notHaveName(names: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not have name.

notHaveNameEndingWith

open fun notHaveNameEndingWith(vararg suffixes: String): PropertiesRuleBuilder

open infix fun notHaveNameEndingWith(suffix: String): PropertiesRuleBuilder

open infix fun notHaveNameEndingWith(suffixes: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not have name ending with.

notHaveNameIn

open fun notHaveNameIn(vararg names: String): PropertiesRuleBuilder

open infix fun notHaveNameIn(names: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not have name in.

notHaveNameMatching

open fun notHaveNameMatching(vararg patterns: String): PropertiesRuleBuilder

open infix fun notHaveNameMatching(pattern: String): PropertiesRuleBuilder

open infix fun notHaveNameMatching(patterns: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not have name matching.

notHaveNameStartingWith

open fun notHaveNameStartingWith(vararg prefixes: String): PropertiesRuleBuilder

open infix fun notHaveNameStartingWith(prefix: String): PropertiesRuleBuilder

open infix fun notHaveNameStartingWith(prefixes: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not have name starting with.

notReferenceClass

open fun notReferenceClass(fqName: String): PropertiesRuleBuilder

open fun notReferenceClass(kClass: KClass<*>): PropertiesRuleBuilder

Filter or assertion criteria for not reference class.

notReferenceClass

inline fun <T : Any> PropertiesShould.notReferenceClass(): PropertiesRuleBuilder

Asserts that properties do not reference class type parameter T.

notResideInAModule

open fun notResideInAModule(vararg modulePaths: String): PropertiesRuleBuilder

open infix fun notResideInAModule(modulePath: String): PropertiesRuleBuilder

open infix fun notResideInAModule(modulePaths: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not reside in a module.

notResideInAPackage

open fun notResideInAPackage(vararg packagePatterns: String): PropertiesRuleBuilder

open infix fun notResideInAPackage(packagePattern: String): PropertiesRuleBuilder

open infix fun notResideInAPackage(packagePatterns: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not reside in a package.

notResideInModule

open fun notResideInModule(vararg modulePaths: String): PropertiesRuleBuilder

open infix fun notResideInModule(modulePath: String): PropertiesRuleBuilder

open infix fun notResideInModule(modulePaths: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not reside in module.

notResideInModules

open fun notResideInModules(vararg modulePaths: String): PropertiesRuleBuilder

open infix fun notResideInModules(modulePaths: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not reside in modules.

notResideInPackage

open fun notResideInPackage(vararg packagePatterns: String): PropertiesRuleBuilder

open infix fun notResideInPackage(packagePattern: String): PropertiesRuleBuilder

open infix fun notResideInPackage(packagePatterns: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for not reside in package.

onlyDependOnPackageOf

open fun onlyDependOnPackageOf(vararg classes: KClass<*>): PropertiesRuleBuilder

Asserts that selected properties only depend on package containing classes.

onlyDependOnPackageOf

inline fun <T : Any> PropertiesShould.onlyDependOnPackageOf(): PropertiesRuleBuilder

Asserts that properties only depend on package of T.

onlyDependOnPackages

open fun onlyDependOnPackages(vararg patterns: String): PropertiesRuleBuilder

open infix fun onlyDependOnPackages(patterns: List<String>): PropertiesRuleBuilder

Asserts that selected properties only depend on types or usages in packages matching patterns.

resideInAModule

open fun resideInAModule(vararg modulePaths: String): PropertiesRuleBuilder

open infix fun resideInAModule(modulePath: String): PropertiesRuleBuilder

open infix fun resideInAModule(modulePaths: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for reside in a module.

resideInAPackage

open fun resideInAPackage(vararg packagePatterns: String): PropertiesRuleBuilder

open infix fun resideInAPackage(predicate: (String) -> Boolean): PropertiesRuleBuilder

open infix fun resideInAPackage(packagePattern: String): PropertiesRuleBuilder

open infix fun resideInAPackage(packagePatterns: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for reside in a package.

resideInModule

open fun resideInModule(vararg modulePaths: String): PropertiesRuleBuilder

open infix fun resideInModule(modulePath: String): PropertiesRuleBuilder

open infix fun resideInModule(modulePaths: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for reside in module.

resideInModules

open fun resideInModules(vararg modulePaths: String): PropertiesRuleBuilder

open infix fun resideInModules(modulePaths: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for reside in modules.

resideInPackage

open fun resideInPackage(vararg packagePatterns: String): PropertiesRuleBuilder

open infix fun resideInPackage(predicate: (String) -> Boolean): PropertiesRuleBuilder

open infix fun resideInPackage(packagePattern: String): PropertiesRuleBuilder

open infix fun resideInPackage(packagePatterns: List<String>): PropertiesRuleBuilder

Filter or assertion criteria for reside in package.

resideInPackageOf

inline fun <T : Any> PropertiesShould.resideInPackageOf(): PropertiesRuleBuilder

Asserts that properties reside in the package of type parameter T.

infix fun PropertiesShould.resideInPackageOf(type: KClass<*>): PropertiesRuleBuilder

Asserts that properties reside in the package of type.

satisfy

open infix fun satisfy(assertion: (PropertyDeclarationContext) -> Boolean): PropertiesRuleBuilder

Asserts that selected properties satisfy a custom boolean condition.

open fun satisfy(assertion: (PropertyDeclarationContext, MutableList<String>) -> Unit): PropertiesRuleBuilder

Asserts that selected properties satisfy a custom violation-collecting assertion.

open infix fun satisfy(description: String): PropertiesRuleBuilder

Asserts that selected properties satisfy custom description description.

open fun satisfy(description: String, assertion: (PropertyDeclarationContext, List<PropertyDeclarationContext>) -> Boolean): PropertiesRuleBuilder

Asserts that selected properties satisfy a custom boolean condition with description.

open fun satisfy(id: String, description: String? = null, predicate: SatisfyContext<PropertyDeclarationContext>.(PropertyDeclarationContext) -> Boolean): PropertiesRuleBuilder

Asserts that selected properties satisfy a custom predicate within a SatisfyContext block identified by id and optional description.