library/io.github.baole.konture/ClassesThat

ClassesThat

class ClassesThat : ClassesThatPackageFilter, ClassesThatNameFilter, ClassesThatStructureFilter, ClassesThatMetadataFilter, ClassesThatCompositeFilter

Fluent API for filtering Kotlin classes in architecture rules.

Properties

builder

open override val builder: ClassesRuleBuilder

Filter or assertion criteria for builder.

Functions

allOf

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

Filter or assertion criteria for all of.

annotatedWith

inline fun <T : Annotation> annotatedWith(): ClassesRuleBuilder

Filters classes annotated with annotation type parameter T.

open infix fun annotatedWith(annotationFqName: String): ClassesRuleBuilder

open infix fun annotatedWith(annotation: KClass<out Annotation>): ClassesRuleBuilder

Specifies annotated with criteria.

annotatedWith

inline fun <T : Annotation> ClassesThat.annotatedWith(): ClassesRuleBuilder

Filters classes having annotation type parameter T.

infix fun ClassesThat.annotatedWith(annotation: KClass<out Annotation>): ClassesRuleBuilder

Filters classes having the specified annotation class.

annotatedWithAllOf

open fun annotatedWithAllOf(vararg names: String): ClassesRuleBuilder

Filter or assertion criteria for annotated with all of.

open infix fun annotatedWithAllOf(name: String): ClassesRuleBuilder

open infix fun annotatedWithAllOf(names: List<String>): ClassesRuleBuilder

Specifies annotated with all of criteria.

annotatedWithAllOf

fun ClassesThat.annotatedWithAllOf(vararg annotations: KClass<out Annotation>): ClassesRuleBuilder

Filters classes having all of the specified annotations.

annotatedWithAnyOf

open fun annotatedWithAnyOf(vararg names: String): ClassesRuleBuilder

Filter or assertion criteria for annotated with any of.

open infix fun annotatedWithAnyOf(name: String): ClassesRuleBuilder

open infix fun annotatedWithAnyOf(names: List<String>): ClassesRuleBuilder

Specifies annotated with any of criteria.

annotatedWithAnyOf

fun ClassesThat.annotatedWithAnyOf(vararg annotations: KClass<out Annotation>): ClassesRuleBuilder

Filters classes having any of the specified annotations.

anyOf

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

Filter or assertion criteria for any of.

areAbstract

open fun areAbstract(): ClassesRuleBuilder

Filter or assertion criteria for are abstract.

areAssignableFrom

inline fun <T : Any> areAssignableFrom(): ClassesRuleBuilder

Filters classes that are assignable from type parameter T.

open fun areAssignableFrom(vararg subTypes: String): ClassesRuleBuilder

Filter or assertion criteria for are assignable from.

open infix fun areAssignableFrom(subType: String): ClassesRuleBuilder

open infix fun areAssignableFrom(subTypes: List<String>): ClassesRuleBuilder

open infix fun areAssignableFrom(subType: KClass<*>): ClassesRuleBuilder

Specifies are assignable from criteria.

areAssignableFrom

inline fun <T : Any> ClassesThat.areAssignableFrom(): ClassesRuleBuilder

Filters classes that are assignable from type parameter T.

infix fun ClassesThat.areAssignableFrom(subType: KClass<*>): ClassesRuleBuilder

Filters classes that are assignable from the specified subType.

areAssignableTo

inline fun <T : Any> areAssignableTo(): ClassesRuleBuilder

Filters classes that are assignable to type parameter T.

open fun areAssignableTo(vararg superTypes: String): ClassesRuleBuilder

Filter or assertion criteria for are assignable to.

open infix fun areAssignableTo(superType: String): ClassesRuleBuilder

open infix fun areAssignableTo(superTypes: List<String>): ClassesRuleBuilder

open infix fun areAssignableTo(superType: KClass<*>): ClassesRuleBuilder

Specifies are assignable to criteria.

areAssignableTo

inline fun <T : Any> ClassesThat.areAssignableTo(): ClassesRuleBuilder

Filters classes that are assignable to type parameter T.

@JvmName(name = "areAssignableToKClasses")

infix fun ClassesThat.areAssignableTo(superTypes: List<KClass<*>>): ClassesRuleBuilder

Filters classes assignable to superTypes.

infix fun ClassesThat.areAssignableTo(superType: KClass<*>): ClassesRuleBuilder

Filters classes that are assignable to the specified superType.

areAssignableToAllOf

open fun areAssignableToAllOf(vararg superTypes: String): ClassesRuleBuilder

open fun areAssignableToAllOf(first: KClass<*>, vararg additional: KClass<*>): ClassesRuleBuilder

Filter or assertion criteria for are assignable to all of.

open infix fun areAssignableToAllOf(superType: String): ClassesRuleBuilder

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

Specifies are assignable to all of criteria.

areAssignableToAllOf

fun ClassesThat.areAssignableToAllOf(vararg superTypes: KClass<*>): ClassesRuleBuilder

Filters classes that are assignable to all of the specified superTypes.

areAssignableToAnyOf

open fun areAssignableToAnyOf(vararg superTypes: String): ClassesRuleBuilder

open fun areAssignableToAnyOf(first: KClass<*>, vararg additional: KClass<*>): ClassesRuleBuilder

Filter or assertion criteria for are assignable to any of.

open infix fun areAssignableToAnyOf(superType: String): ClassesRuleBuilder

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

Specifies are assignable to any of criteria.

areAssignableToAnyOf

fun ClassesThat.areAssignableToAnyOf(vararg superTypes: KClass<*>): ClassesRuleBuilder

Filters classes that are assignable to any of the specified superTypes.

areEnums

open fun areEnums(): ClassesRuleBuilder

Filter or assertion criteria for are enums.

areInner

open fun areInner(): ClassesRuleBuilder

Filter or assertion criteria for are inner.

areInterfaces

open fun areInterfaces(): ClassesRuleBuilder

Filter or assertion criteria for are interfaces.

areNested

open fun areNested(): ClassesRuleBuilder

Filter or assertion criteria for are nested.

areNotAssignableFrom

open infix fun areNotAssignableFrom(subType: String): ClassesRuleBuilder

open infix fun areNotAssignableFrom(type: KClass<*>): ClassesRuleBuilder

Specifies are not assignable from criteria.

areNotAssignableFrom

inline fun <T : Any> ClassesThat.areNotAssignableFrom(): ClassesRuleBuilder

Filters classes that are not assignable from type parameter T.

areNotAssignableTo

open infix fun areNotAssignableTo(superType: String): ClassesRuleBuilder

open infix fun areNotAssignableTo(type: KClass<*>): ClassesRuleBuilder

Specifies are not assignable to criteria.

areNotAssignableTo

inline fun <T : Any> ClassesThat.areNotAssignableTo(): ClassesRuleBuilder

Filters classes that are not assignable to type parameter T.

areOpen

open fun areOpen(): ClassesRuleBuilder

Filter or assertion criteria for are open.

areOverride

open fun areOverride(): ClassesRuleBuilder

Filter or assertion criteria for are override.

areTopLevel

open fun areTopLevel(): ClassesRuleBuilder

Filter or assertion criteria for are top level.

beChildOf

inline fun <T : Any> beChildOf(): ClassesRuleBuilder

Filters classes that are children of type parameter T.

open infix fun beChildOf(superType: String): ClassesRuleBuilder

open infix fun beChildOf(superType: KClass<*>): ClassesRuleBuilder

Specifies be child of criteria.

beData

open fun beData(): ClassesRuleBuilder

Filter or assertion criteria for be data.

beDocumentedWithKDoc

open fun beDocumentedWithKDoc(): ClassesRuleBuilder

Filter or assertion criteria for be documented with k doc.

beInline

open fun beInline(): ClassesRuleBuilder

Filter or assertion criteria for be inline.

beInternal

open fun beInternal(): ClassesRuleBuilder

Filter or assertion criteria for be internal.

bePrivate

open fun bePrivate(): ClassesRuleBuilder

Filter or assertion criteria for be private.

beProtected

open fun beProtected(): ClassesRuleBuilder

Filter or assertion criteria for be protected.

bePublic

open fun bePublic(): ClassesRuleBuilder

Filter or assertion criteria for be public.

beSealed

open fun beSealed(): ClassesRuleBuilder

Filter or assertion criteria for be sealed.

containFunction

open fun containFunction(vararg functionNames: String): ClassesRuleBuilder

Filter or assertion criteria for contain function.

open infix fun containFunction(functionName: String): ClassesRuleBuilder

open infix fun containFunction(functionNames: List<String>): ClassesRuleBuilder

Specifies contain function criteria.

containFunctions

open fun containFunctions(vararg functionNames: String): ClassesRuleBuilder

Filter or assertion criteria for contain functions.

open infix fun containFunctions(functionNames: List<String>): ClassesRuleBuilder

Specifies contain functions criteria.

containProperties

open fun containProperties(vararg propertyNames: String): ClassesRuleBuilder

Filter or assertion criteria for contain properties.

open infix fun containProperties(propertyNames: List<String>): ClassesRuleBuilder

Specifies contain properties criteria.

containProperty

open fun containProperty(vararg propertyNames: String): ClassesRuleBuilder

Filter or assertion criteria for contain property.

open infix fun containProperty(propertyName: String): ClassesRuleBuilder

open infix fun containProperty(propertyNames: List<String>): ClassesRuleBuilder

Specifies contain property criteria.

haveAllModifiers

open infix fun haveAllModifiers(modifier: Modifier): ClassesRuleBuilder

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

Specifies have all modifiers criteria.

open fun haveAllModifiers(vararg modifiers: Modifier): ClassesRuleBuilder

Filter or assertion criteria for have all modifiers.

haveAnnotationWithArgument

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

Filter or assertion criteria for have annotation with argument.

haveAnnotationWithArgument

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

Filters classes having an annotation annotation with argument argName equal to argValue.

haveAnyModifier

open infix fun haveAnyModifier(modifier: Modifier): ClassesRuleBuilder

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

Specifies have any modifier criteria.

open fun haveAnyModifier(vararg modifiers: Modifier): ClassesRuleBuilder

Filter or assertion criteria for have any modifier.

haveAnyVisibility

open infix fun haveAnyVisibility(visibility: Visibility): ClassesRuleBuilder

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

Specifies have any visibility criteria.

open fun haveAnyVisibility(vararg visibilities: Visibility): ClassesRuleBuilder

Filter or assertion criteria for have any visibility.

haveCompanionObject

open fun haveCompanionObject(): ClassesRuleBuilder

Filter or assertion criteria for have companion object.

haveModifier

open infix fun haveModifier(modifier: Modifier): ClassesRuleBuilder

Specifies have modifier criteria.

haveNoArgConstructor

open fun haveNoArgConstructor(): ClassesRuleBuilder

Filter or assertion criteria for have no arg constructor.

havePrivatePrimaryConstructor

open fun havePrivatePrimaryConstructor(): ClassesRuleBuilder

Filter or assertion criteria for have private primary constructor.

haveVisibility

open infix fun haveVisibility(visibility: Visibility): ClassesRuleBuilder

Specifies have visibility criteria.

inModule

open fun inModule(vararg modulePaths: String): ClassesRuleBuilder

Filter or assertion criteria for in module.

open infix fun inModule(modulePath: String): ClassesRuleBuilder

open infix fun inModule(modulePaths: List<String>): ClassesRuleBuilder

Specifies in module criteria.

inModules

open fun inModules(vararg modulePaths: String): ClassesRuleBuilder

Filter or assertion criteria for in modules.

open infix fun inModules(modulePaths: List<String>): ClassesRuleBuilder

Specifies in modules criteria.

inPackage

open fun inPackage(vararg packagePatterns: String): ClassesRuleBuilder

Filter or assertion criteria for in package.

open infix fun inPackage(predicate: (String) -> Boolean): ClassesRuleBuilder

open infix fun inPackage(packagePattern: String): ClassesRuleBuilder

open infix fun inPackage(packagePatterns: List<String>): ClassesRuleBuilder

Specifies in package criteria.

inPackageOf

open infix fun inPackageOf(type: KClass<*>): ClassesRuleBuilder

Specifies in package of criteria.

inPackageOf

inline fun <T : Any> ClassesThat.inPackageOf(): ClassesRuleBuilder

Filters classes residing in the package of type parameter T.

infix fun ClassesThat.inPackageOf(type: KClass<*>): ClassesRuleBuilder

Filters classes residing in the package of type.

matching

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

Specifies matching criteria.

named

open fun named(vararg names: String): ClassesRuleBuilder

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

Filter or assertion criteria for named.

open infix fun named(predicate: (String) -> Boolean): ClassesRuleBuilder

open infix fun named(name: String): ClassesRuleBuilder

open infix fun named(names: List<String>): ClassesRuleBuilder

Specifies named criteria.

nameEndsWith

open fun nameEndsWith(vararg suffixes: String): ClassesRuleBuilder

Filter or assertion criteria for name ends with.

open infix fun nameEndsWith(suffix: String): ClassesRuleBuilder

open infix fun nameEndsWith(suffixes: List<String>): ClassesRuleBuilder

Specifies name ends with criteria.

nameMatches

open fun nameMatches(vararg patterns: String): ClassesRuleBuilder

Filter or assertion criteria for name matches.

open infix fun nameMatches(pattern: String): ClassesRuleBuilder

open infix fun nameMatches(patterns: List<String>): ClassesRuleBuilder

Specifies name matches criteria.

nameStartsWith

open fun nameStartsWith(vararg prefixes: String): ClassesRuleBuilder

Filter or assertion criteria for name starts with.

open infix fun nameStartsWith(prefix: String): ClassesRuleBuilder

open infix fun nameStartsWith(prefixes: List<String>): ClassesRuleBuilder

Specifies name starts with criteria.

noneOf

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

Filter or assertion criteria for none of.

not

open fun not(): ClassesThat

Filter or assertion criteria for not.

notInModule

open fun notInModule(vararg modulePaths: String): ClassesRuleBuilder

Filter or assertion criteria for not in module.

open infix fun notInModule(modulePath: String): ClassesRuleBuilder

open infix fun notInModule(modulePaths: List<String>): ClassesRuleBuilder

Specifies not in module criteria.

notInModules

open fun notInModules(vararg modulePaths: String): ClassesRuleBuilder

Filter or assertion criteria for not in modules.

open infix fun notInModules(modulePaths: List<String>): ClassesRuleBuilder

Specifies not in modules criteria.

notInPackage

open fun notInPackage(vararg packagePatterns: String): ClassesRuleBuilder

Filter or assertion criteria for not in package.

open infix fun notInPackage(packagePattern: String): ClassesRuleBuilder

open infix fun notInPackage(packagePatterns: List<String>): ClassesRuleBuilder

Specifies not in package criteria.

notNamed

open fun notNamed(vararg names: String): ClassesRuleBuilder

Filter or assertion criteria for not named.

open infix fun notNamed(predicate: (String) -> Boolean): ClassesRuleBuilder

open infix fun notNamed(name: String): ClassesRuleBuilder

open infix fun notNamed(names: List<String>): ClassesRuleBuilder

Specifies not named criteria.

notNameEndsWith

open fun notNameEndsWith(vararg suffixes: String): ClassesRuleBuilder

Filter or assertion criteria for not name ends with.

open infix fun notNameEndsWith(suffix: String): ClassesRuleBuilder

open infix fun notNameEndsWith(suffixes: List<String>): ClassesRuleBuilder

Specifies not name ends with criteria.

notNameMatches

open fun notNameMatches(vararg patterns: String): ClassesRuleBuilder

Filter or assertion criteria for not name matches.

open infix fun notNameMatches(pattern: String): ClassesRuleBuilder

open infix fun notNameMatches(patterns: List<String>): ClassesRuleBuilder

Specifies not name matches criteria.

notNameStartsWith

open fun notNameStartsWith(vararg prefixes: String): ClassesRuleBuilder

Filter or assertion criteria for not name starts with.

open infix fun notNameStartsWith(prefix: String): ClassesRuleBuilder

open infix fun notNameStartsWith(prefixes: List<String>): ClassesRuleBuilder

Specifies not name starts with criteria.

satisfy

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

Filter or assertion criteria for satisfy.

simpleNamed

open infix fun simpleNamed(name: String): ClassesRuleBuilder

Specifies simple named criteria.