library/io.github.baole.konture/PropertyAssertionScope

PropertyAssertionScope

class PropertyAssertionScope

Assertion scope DSL for configuring rule expectations on Kotlin properties.

Properties

Link copied to clipboard
val assertions: MutableList<(PropertyDeclaration, MutableList<String>) -> Unit>

Filter or assertion criteria for assertions.

Functions

Link copied to clipboard
fun beDocumentedWithKDoc()

Filter or assertion criteria for be documented with k doc.

Link copied to clipboard
fun beInternal()

Filter or assertion criteria for be internal.

Link copied to clipboard
fun bePrivate()

Filter or assertion criteria for be private.

Link copied to clipboard
fun beProtected()

Filter or assertion criteria for be protected.

Link copied to clipboard
fun bePublic()

Filter or assertion criteria for be public.

Link copied to clipboard
fun beVal()

Filter or assertion criteria for be val.

Link copied to clipboard
fun beVar()

Filter or assertion criteria for be var.

Link copied to clipboard
fun haveAllAnnotationsOf(vararg names: String)
fun haveAllAnnotationsOf(names: List<String>)

Asserts that member properties are annotated with all of the specified annotations.

Link copied to clipboard
fun haveAllModifiers(vararg modifiers: Modifier)
fun haveAllModifiers(modifiers: List<Modifier>)

Asserts that member properties have all of the specified modifiers.

Link copied to clipboard
fun haveAnnotationOf(vararg annotationNames: String)
fun haveAnnotationOf(annotationName: String)
fun haveAnnotationOf(annotationNames: List<String>)

Filter or assertion criteria for have annotation of.

Link copied to clipboard
fun PropertyAssertionScope.haveAnnotationOf(annotation: KClass<out Annotation>)

Asserts that properties in this assertion scope have the specified annotation class.

Link copied to clipboard
inline fun <T : Annotation> PropertyAssertionScope.haveAnnotationOfType()

Asserts that properties in this assertion scope have the annotation specified by T.

Link copied to clipboard
fun haveAnyAnnotationOf(vararg names: String)
fun haveAnyAnnotationOf(names: List<String>)

Asserts that member properties are annotated with any of the specified annotations.

Link copied to clipboard
fun haveAnyModifier(vararg modifiers: Modifier)
fun haveAnyModifier(modifiers: List<Modifier>)

Asserts that member properties have any of the specified modifiers.

Link copied to clipboard
fun haveAnyVisibility(vararg visibilities: Visibility)
fun haveAnyVisibility(visibilities: List<Visibility>)

Asserts that member properties have any of the specified visibilities.

Link copied to clipboard
fun haveNameEndingWith(vararg suffixes: String)
fun haveNameEndingWith(suffix: String)
fun haveNameEndingWith(suffixes: List<String>)

Filter or assertion criteria for have name ending with.

Link copied to clipboard
fun haveNameMatching(vararg patterns: String)
fun haveNameMatching(pattern: String)
fun haveNameMatching(patterns: List<String>)

Filter or assertion criteria for have name matching.

Link copied to clipboard
fun haveNameStartingWith(vararg prefixes: String)
fun haveNameStartingWith(prefix: String)
fun haveNameStartingWith(prefixes: List<String>)

Filter or assertion criteria for have name starting with.

Link copied to clipboard
fun haveType(vararg typeFqNames: String)
fun haveType(typeFqName: String)
fun haveType(typeFqNames: List<String>)

Filter or assertion criteria for have type.

Link copied to clipboard
fun PropertyAssertionScope.haveType(type: KClass<*>)

Asserts that properties in this assertion scope have the specified type type.

Link copied to clipboard
inline fun <T : Any> PropertyAssertionScope.haveTypeOf()

Asserts that properties in this assertion scope have the type specified by T.