library/io.github.baole.konture/ClassesThat

ClassesThat

class ClassesThat

Fluent API for defining filtering conditions on Kotlin classes.

Functions

allOf

fun allOf(vararg blocks: ClassesThat.() -> Unit): ClassesRuleBuilder

Matches if all of the nested condition blocks are satisfied.

anyOf

fun anyOf(vararg blocks: ClassesThat.() -> Unit): ClassesRuleBuilder

Matches if any of the nested condition blocks are satisfied.

areAbstract

fun areAbstract(): ClassesRuleBuilder

Restricts the rules to abstract classes only.

areAssignableTo

infix fun areAssignableTo(superType: String): ClassesRuleBuilder

Restricts the rules to classes extending or implementing the specified type.

areAssignableToAllOf

fun areAssignableToAllOf(vararg superTypes: String): ClassesRuleBuilder

infix fun areAssignableToAllOf(superTypes: List<String>): ClassesRuleBuilder

Restricts the rules to classes extending or implementing all of the specified supertypes.

infix fun areAssignableToAllOf(superType: String): ClassesRuleBuilder

Restricts the rules to classes extending or implementing the specified supertype.

areAssignableToAnyOf

fun areAssignableToAnyOf(vararg superTypes: String): ClassesRuleBuilder

infix fun areAssignableToAnyOf(superTypes: List<String>): ClassesRuleBuilder

Restricts the rules to classes extending or implementing any of the specified supertypes.

infix fun areAssignableToAnyOf(superType: String): ClassesRuleBuilder

Restricts the rules to classes extending or implementing the specified supertype.

areEnums

fun areEnums(): ClassesRuleBuilder

Restricts the rules to enum classes only.

areInterfaces

fun areInterfaces(): ClassesRuleBuilder

Restricts the rules to interface definitions only.

beData

fun beData(): ClassesRuleBuilder

beDocumentedWithKDoc

fun beDocumentedWithKDoc(): ClassesRuleBuilder

Restricts the rules to classes that are documented with a KDoc comment.

beInline

fun beInline(): ClassesRuleBuilder

beInternal

fun beInternal(): ClassesRuleBuilder

bePrivate

fun bePrivate(): ClassesRuleBuilder

beProtected

fun beProtected(): ClassesRuleBuilder

bePublic

fun bePublic(): ClassesRuleBuilder

beSealed

fun beSealed(): ClassesRuleBuilder

haveAllAnnotationsOf

fun haveAllAnnotationsOf(vararg names: String): ClassesRuleBuilder

infix fun haveAllAnnotationsOf(names: List<String>): ClassesRuleBuilder

Restricts the rules to classes annotated with all of the specified annotations. Matches either simple names or FQNs.

infix fun haveAllAnnotationsOf(name: String): ClassesRuleBuilder

Restricts the rules to classes annotated with the specified annotation. Matches either simple names or FQNs.

haveAllModifiers

infix fun haveAllModifiers(modifier: Modifier): ClassesRuleBuilder

Restricts the rules to classes containing specified modifier.

fun haveAllModifiers(vararg modifiers: Modifier): ClassesRuleBuilder

infix fun haveAllModifiers(modifiers: List<Modifier>): ClassesRuleBuilder

Restricts the rules to classes containing all of the specified modifiers.

haveAnnotationOf

infix fun haveAnnotationOf(annotationFqName: String): ClassesRuleBuilder

Restricts the rules to classes annotated with the specified annotation. Matches either the annotation's simple name or its FQN.

haveAnnotationWithArgument

fun haveAnnotationWithArgument(annotationName: String, argName: String?, argValue: String): ClassesRuleBuilder

Restricts the rules to classes with specified annotation having a matching argument name and value.

haveAnyAnnotationOf

fun haveAnyAnnotationOf(vararg names: String): ClassesRuleBuilder

infix fun haveAnyAnnotationOf(names: List<String>): ClassesRuleBuilder

Restricts the rules to classes annotated with any of the specified annotations. Matches either simple names or FQNs.

infix fun haveAnyAnnotationOf(name: String): ClassesRuleBuilder

Restricts the rules to classes annotated with the specified annotation. Matches either simple names or FQNs.

haveAnyModifier

infix fun haveAnyModifier(modifier: Modifier): ClassesRuleBuilder

Restricts the rules to classes containing specified modifier.

fun haveAnyModifier(vararg modifiers: Modifier): ClassesRuleBuilder

infix fun haveAnyModifier(modifiers: List<Modifier>): ClassesRuleBuilder

Restricts the rules to classes containing any of the specified modifiers.

haveAnyVisibility

infix fun haveAnyVisibility(visibility: Visibility): ClassesRuleBuilder

Restricts the rules to classes with the specified visibility.

fun haveAnyVisibility(vararg visibilities: Visibility): ClassesRuleBuilder

infix fun haveAnyVisibility(visibilities: List<Visibility>): ClassesRuleBuilder

Restricts the rules to classes with any of the specified visibilities.

haveModifier

infix fun haveModifier(modifier: Modifier): ClassesRuleBuilder

Restricts the rules to classes containing specified modifier.

haveName

infix fun haveName(predicate: (String) -> Boolean): ClassesRuleBuilder

fun haveName(description: String, predicate: (String) -> Boolean): ClassesRuleBuilder

Restricts the rules to classes whose simple names match the specified predicate.

haveNameEndingWith

fun haveNameEndingWith(vararg suffixes: String): ClassesRuleBuilder

infix fun haveNameEndingWith(suffixes: List<String>): ClassesRuleBuilder

Restricts the rules to classes whose simple names end with any of the specified suffixes.

infix fun haveNameEndingWith(suffix: String): ClassesRuleBuilder

Restricts the rules to classes whose simple names end with the specified suffix.

haveNameMatching

fun haveNameMatching(vararg patterns: String): ClassesRuleBuilder

infix fun haveNameMatching(patterns: List<String>): ClassesRuleBuilder

Restricts the rules to classes whose simple names match any of the specified glob patterns. Supports '*' wildcards.

infix fun haveNameMatching(pattern: String): ClassesRuleBuilder

Restricts the rules to classes whose simple names match the specified glob pattern. Supports '*' wildcards.

haveNameStartingWith

fun haveNameStartingWith(vararg prefixes: String): ClassesRuleBuilder

infix fun haveNameStartingWith(prefixes: List<String>): ClassesRuleBuilder

Restricts the rules to classes whose simple names start with any of the specified prefixes.

infix fun haveNameStartingWith(prefix: String): ClassesRuleBuilder

Restricts the rules to classes whose simple names start with the specified prefix.

haveVisibility

infix fun haveVisibility(visibility: Visibility): ClassesRuleBuilder

Restricts the rules to classes with specified visibility.

matching

infix fun matching(predicate: (ClassDeclaration) -> Boolean): ClassesRuleBuilder

Restricts the rules to classes matching the specified predicate.

noneOf

fun noneOf(vararg blocks: ClassesThat.() -> Unit): ClassesRuleBuilder

Matches if none of the nested condition blocks are satisfied.

resideInAPackage

fun resideInAPackage(vararg packagePatterns: String): ClassesRuleBuilder

Restricts the rules to classes residing in packages matching any of the specified patterns. Supports .. segment wildcards.

infix fun resideInAPackage(predicate: (String) -> Boolean): ClassesRuleBuilder

Restricts the rules to classes residing in packages matching the specified predicate.

infix fun resideInAPackage(packagePattern: String): ClassesRuleBuilder

Restricts the rules to classes residing in packages matching the specified pattern. Supports .. segment wildcards (e.g., io.github.baole.konture..).

infix fun resideInAPackage(packagePatterns: List<String>): ClassesRuleBuilder

Restricts the rules to classes residing in packages matching any of the specified patterns. Supports .. segment wildcards (e.g., io.github.baole.konture..).

satisfy

fun satisfy(predicate: (ClassDeclaration) -> Boolean): ClassesRuleBuilder

Satisfies an arbitrary custom predicate logic.