library/io.github.baole.konture/FunctionsThat

FunctionsThat

class FunctionsThat : FunctionsThatPackageFilter, FunctionsThatNameFilter, FunctionsThatStructureFilter, FunctionsThatModifierFilter, FunctionsThatDependencyFilter, FunctionsThatCompositeFilter

Fluent API for filtering Kotlin functions in architecture rules.

Properties

Link copied to clipboard
open override val builder: FunctionsRuleBuilder

Filter or assertion criteria for builder.

Functions

Link copied to clipboard
open fun allOf(vararg blocks: FunctionsThat.() -> Unit): FunctionsRuleBuilder

Filters functions satisfying all conditions specified in blocks.

Link copied to clipboard
open fun anyOf(vararg blocks: FunctionsThat.() -> Unit): FunctionsRuleBuilder

Filters functions satisfying at least one condition specified in blocks.

Link copied to clipboard
open fun areAbstract(): FunctionsRuleBuilder

Filters functions declared with Modifier.ABSTRACT.

Link copied to clipboard
inline fun <T : Annotation> areAnnotatedWith(): FunctionsRuleBuilder

Filters functions annotated with annotation type parameter T.

open infix fun areAnnotatedWith(annotationName: String): FunctionsRuleBuilder

Filters functions annotated with annotation annotationName.

open infix fun areAnnotatedWith(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions annotated with annotation annotation.

Link copied to clipboard
infix fun FunctionsThat.areAnnotatedWith(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions annotated with the specified annotation class.

Link copied to clipboard
open fun areExtension(): FunctionsRuleBuilder

Filters functions that are extension functions.

Link copied to clipboard
open fun areInternal(): FunctionsRuleBuilder

Filters functions that have Visibility.INTERNAL visibility.

Link copied to clipboard
open fun areMember(): FunctionsRuleBuilder

Filters functions that are member functions within a class or object.

Link copied to clipboard
open fun areOpen(): FunctionsRuleBuilder

Filters functions declared with Modifier.OPEN.

Link copied to clipboard
open fun areOverride(): FunctionsRuleBuilder

Filters functions declared with Modifier.OVERRIDE.

Link copied to clipboard
open fun arePrivate(): FunctionsRuleBuilder

Filters functions that have Visibility.PRIVATE visibility.

Link copied to clipboard
open fun areProtected(): FunctionsRuleBuilder

Filters functions that have Visibility.PROTECTED visibility.

Link copied to clipboard
open fun arePublic(): FunctionsRuleBuilder

Filters functions that have Visibility.PUBLIC visibility.

Link copied to clipboard
open fun areTopLevel(): FunctionsRuleBuilder

Filters functions that are top-level declarations.

Link copied to clipboard
open fun beInfix(): FunctionsRuleBuilder

Filters functions declared with Modifier.INFIX.

Link copied to clipboard
open fun beInline(): FunctionsRuleBuilder

Filters functions declared with Modifier.INLINE.

Link copied to clipboard
open fun beInternal(): FunctionsRuleBuilder

Filters functions that have Visibility.INTERNAL visibility.

Link copied to clipboard
open infix fun belongToClass(className: String): FunctionsRuleBuilder

Filters functions declared within a class matching className.

open infix fun belongToClass(type: KClass<*>): FunctionsRuleBuilder

Filters functions declared within class type.

Link copied to clipboard
open fun beMember(): FunctionsRuleBuilder

Filters functions that are member functions within a class or object.

Link copied to clipboard
open fun beOperator(): FunctionsRuleBuilder

Filters functions declared with Modifier.OPERATOR.

Link copied to clipboard
open fun bePrivate(): FunctionsRuleBuilder

Filters functions that have Visibility.PRIVATE visibility.

Link copied to clipboard
open fun beProtected(): FunctionsRuleBuilder

Filters functions that have Visibility.PROTECTED visibility.

Link copied to clipboard
open fun bePublic(): FunctionsRuleBuilder

Filters functions that have Visibility.PUBLIC visibility.

Link copied to clipboard
open fun beSuspend(): FunctionsRuleBuilder

Filters functions declared with Modifier.SUSPEND.

Link copied to clipboard
open fun beTopLevel(): FunctionsRuleBuilder

Filters functions that are top-level declarations.

Link copied to clipboard
open fun dependOnPackageOf(vararg classes: KClass<*>): FunctionsRuleBuilder

Filters functions that depend on the package containing any of classes.

Link copied to clipboard
inline fun <T : Any> FunctionsThat.dependOnPackageOf(): FunctionsRuleBuilder

Filters functions depending on package of T.

Link copied to clipboard
open fun dependOnPackages(vararg patterns: String): FunctionsRuleBuilder
open infix fun dependOnPackages(patterns: List<String>): FunctionsRuleBuilder

Filters functions that depend on packages matching any pattern in patterns.

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

Filters functions annotated with all annotations in names.

Link copied to clipboard
fun FunctionsThat.haveAllAnnotationsOf(vararg annotations: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions having all of the specified annotations.

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

Filters functions declared with all modifiers in modifiers.

Link copied to clipboard
inline fun <T : Annotation> haveAnnotationOf(): FunctionsRuleBuilder

Filters functions having annotation of type parameter T.

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

Filters functions annotated with any of annotationNames.

open infix fun haveAnnotationOf(annotationName: String): FunctionsRuleBuilder

Filters functions annotated with annotation annotationName.

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

Filters functions annotated with annotation annotation.

Link copied to clipboard
inline fun <T : Annotation> FunctionsThat.haveAnnotationOf(): FunctionsRuleBuilder

Filters functions having annotation specified by annotation type parameter T.

infix fun FunctionsThat.haveAnnotationOf(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions having the specified annotation class.

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

Filters functions having the annotation type parameter T.

Link copied to clipboard
open fun haveAnnotationWithArgument(annotationName: String, argName: String?, argValue: String): FunctionsRuleBuilder

Filters functions annotated with annotationName containing argument argName with value argValue.

Link copied to clipboard
fun FunctionsThat.haveAnnotationWithArgument(annotation: KClass<out Annotation>, argName: String?, argValue: String): FunctionsRuleBuilder

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

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

Filters functions annotated with any annotation in names.

Link copied to clipboard
fun FunctionsThat.haveAnyAnnotationOf(vararg annotations: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions having any of the specified annotations.

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

Filters functions declared with any modifier in modifiers.

Link copied to clipboard
open fun haveAnyParameterType(vararg types: String): FunctionsRuleBuilder
open infix fun haveAnyParameterType(types: List<String>): FunctionsRuleBuilder

Filters functions having at least one parameter type matching any in types.

open fun haveAnyParameterType(first: KClass<*>, vararg additional: KClass<*>): FunctionsRuleBuilder

Filters functions having at least one parameter type matching first or any in additional.

Link copied to clipboard
inline fun <T : Any> haveAnyParameterTypeOf(): FunctionsRuleBuilder

Filters functions having any parameter type of type parameter T.

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

Filters functions having any visibility in visibilities.

Link copied to clipboard
inline fun <T : Any> haveExtensionReceiver(): FunctionsRuleBuilder

Filters functions having extension receiver of type parameter T.

open infix fun haveExtensionReceiver(receiverTypeFqName: String): FunctionsRuleBuilder

Filters functions that have an extension receiver matching receiverTypeFqName.

open infix fun haveExtensionReceiver(kClass: KClass<*>): FunctionsRuleBuilder

Filters functions that have an extension receiver of type kClass.

Link copied to clipboard
open infix fun haveModifier(modifier: Modifier): FunctionsRuleBuilder

Filters functions declared with modifier modifier.

Link copied to clipboard
open fun haveName(vararg names: String): FunctionsRuleBuilder
open infix fun haveName(names: List<String>): FunctionsRuleBuilder

Filters functions whose simple name is contained in names.

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

Filters functions whose simple name satisfies predicate.

open infix fun haveName(name: String): FunctionsRuleBuilder

Filters functions whose simple name equals name.

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

Filters functions whose simple name satisfies predicate with a custom description.

Link copied to clipboard
open fun haveNameEndingWith(vararg suffixes: String): FunctionsRuleBuilder
open infix fun haveNameEndingWith(suffixes: List<String>): FunctionsRuleBuilder

Filters functions whose simple name ends with any of suffixes.

open infix fun haveNameEndingWith(suffix: String): FunctionsRuleBuilder

Filters functions whose simple name ends with suffix.

Link copied to clipboard
open fun haveNameMatching(vararg patterns: String): FunctionsRuleBuilder
open infix fun haveNameMatching(patterns: List<String>): FunctionsRuleBuilder

Filters functions whose simple name matches any glob pattern in patterns.

open infix fun haveNameMatching(pattern: String): FunctionsRuleBuilder

Filters functions whose simple name matches glob pattern.

Link copied to clipboard
open fun haveNameStartingWith(vararg prefixes: String): FunctionsRuleBuilder
open infix fun haveNameStartingWith(prefixes: List<String>): FunctionsRuleBuilder

Filters functions whose simple name starts with any of prefixes.

open infix fun haveNameStartingWith(prefix: String): FunctionsRuleBuilder

Filters functions whose simple name starts with prefix.

Link copied to clipboard
open fun haveNoParameters(): FunctionsRuleBuilder

Filters functions that take no parameters.

Link copied to clipboard
open infix fun haveParameterCount(predicate: (Int) -> Boolean): FunctionsRuleBuilder

Filters functions whose parameter count satisfies predicate.

open infix fun haveParameterCount(count: Int): FunctionsRuleBuilder

Filters functions taking exactly count parameters.

Link copied to clipboard
inline fun <T : Any> haveParameterOf(): FunctionsRuleBuilder

Filters functions having parameter of type parameter T.

open fun haveParameterOf(vararg types: String): FunctionsRuleBuilder
open infix fun haveParameterOf(types: List<String>): FunctionsRuleBuilder

Filters functions having at least one parameter matching any type in types.

open infix fun haveParameterOf(typeFqName: String): FunctionsRuleBuilder

Filters functions having at least one parameter matching type typeFqName.

open infix fun haveParameterOf(kClass: KClass<*>): FunctionsRuleBuilder

Filters functions having at least one parameter of type kClass.

Link copied to clipboard
@JvmName(name = "haveParameterOfKClasses")
infix fun FunctionsThat.haveParameterOf(types: List<KClass<*>>): FunctionsRuleBuilder

Filters functions having parameters of the specified types.

Link copied to clipboard
open fun haveParameterTypes(vararg types: String): FunctionsRuleBuilder
open infix fun haveParameterTypes(types: List<String>): FunctionsRuleBuilder

Filters functions whose parameter types exactly match types in order and count.

open fun haveParameterTypes(first: KClass<*>, vararg additional: KClass<*>): FunctionsRuleBuilder

Filters functions whose parameter types exactly match first and additional classes in order and count.

Link copied to clipboard
open fun haveReturnType(vararg typeFqNames: String): FunctionsRuleBuilder
open infix fun haveReturnType(typeFqNames: List<String>): FunctionsRuleBuilder

Filters functions having return type matching any in typeFqNames.

open infix fun haveReturnType(typeFqName: String): FunctionsRuleBuilder

Filters functions having return type matching typeFqName.

open infix fun haveReturnType(type: KClass<*>): FunctionsRuleBuilder

Filters functions having return type matching type.

Link copied to clipboard
inline fun <T : Any> FunctionsThat.haveReturnType(): FunctionsRuleBuilder

Filters functions having return type specified by type parameter T.

Link copied to clipboard
inline fun <T : Any> haveReturnTypeOf(): FunctionsRuleBuilder

Filters functions having return type of type parameter T.

Link copied to clipboard
open infix fun haveVisibility(visibility: Visibility): FunctionsRuleBuilder

Filters functions having visibility.

Link copied to clipboard
open fun noneOf(vararg blocks: FunctionsThat.() -> Unit): FunctionsRuleBuilder

Filters functions satisfying none of the conditions specified in blocks.

Link copied to clipboard
open fun not(): FunctionsThat

Inverts the next filter condition using logical NOT.

Link copied to clipboard
open infix fun notBeAnnotatedWith(annotationName: String): FunctionsRuleBuilder

Filters functions not annotated with annotation annotationName.

open infix fun notBeAnnotatedWith(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions not annotated with annotation annotation.

Link copied to clipboard
open fun notBeInternal(): FunctionsRuleBuilder

Filters functions that do not have Visibility.INTERNAL visibility.

Link copied to clipboard
open fun notBePrivate(): FunctionsRuleBuilder

Filters functions that do not have Visibility.PRIVATE visibility.

Link copied to clipboard
open fun notBeProtected(): FunctionsRuleBuilder

Filters functions that do not have Visibility.PROTECTED visibility.

Link copied to clipboard
open fun notBePublic(): FunctionsRuleBuilder

Filters functions that do not have Visibility.PUBLIC visibility.

Link copied to clipboard
inline fun <T : Any> FunctionsThat.notDependOnPackageOf(): FunctionsRuleBuilder

Filters functions not depending on package of T.

infix fun FunctionsThat.notDependOnPackageOf(type: KClass<*>): FunctionsRuleBuilder

Filters functions not depending on package of type.

Link copied to clipboard
open fun notDependOnPackages(vararg patterns: String): FunctionsRuleBuilder
open infix fun notDependOnPackages(patterns: List<String>): FunctionsRuleBuilder

Filters functions that do not depend on packages matching any pattern in patterns.

Link copied to clipboard
open infix fun notHaveAnnotationOf(annotationName: String): FunctionsRuleBuilder

Filters functions not annotated with annotation annotationName.

open infix fun notHaveAnnotationOf(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Filters functions not annotated with annotation annotation.

Link copied to clipboard
open fun notHaveName(vararg names: String): FunctionsRuleBuilder
open infix fun notHaveName(names: List<String>): FunctionsRuleBuilder

Filters functions whose simple name is not contained in names.

open infix fun notHaveName(predicate: (String) -> Boolean): FunctionsRuleBuilder

Filters functions whose simple name does not satisfy predicate.

open infix fun notHaveName(name: String): FunctionsRuleBuilder

Filters functions whose simple name does not equal name.

Link copied to clipboard
open fun notHaveNameEndingWith(vararg suffixes: String): FunctionsRuleBuilder
open infix fun notHaveNameEndingWith(suffixes: List<String>): FunctionsRuleBuilder

Filters functions whose simple name does not end with any of suffixes.

open infix fun notHaveNameEndingWith(suffix: String): FunctionsRuleBuilder

Filters functions whose simple name does not end with suffix.

Link copied to clipboard
open fun notHaveNameMatching(vararg patterns: String): FunctionsRuleBuilder
open infix fun notHaveNameMatching(patterns: List<String>): FunctionsRuleBuilder

Filters functions whose simple name does not match any glob pattern in patterns.

open infix fun notHaveNameMatching(pattern: String): FunctionsRuleBuilder

Filters functions whose simple name does not match glob pattern.

Link copied to clipboard
open fun notHaveNameStartingWith(vararg prefixes: String): FunctionsRuleBuilder
open infix fun notHaveNameStartingWith(prefixes: List<String>): FunctionsRuleBuilder

Filters functions whose simple name does not start with any of prefixes.

open infix fun notHaveNameStartingWith(prefix: String): FunctionsRuleBuilder

Filters functions whose simple name does not start with prefix.

Link copied to clipboard
open infix fun notHaveParameterOf(typeFqName: String): FunctionsRuleBuilder

Filters functions not having any parameter matching type typeFqName.

open infix fun notHaveParameterOf(type: KClass<*>): FunctionsRuleBuilder

Filters functions not having any parameter of type type.

Link copied to clipboard
inline fun <T : Any> FunctionsThat.notHaveParameterOf(): FunctionsRuleBuilder

Filters functions that do not have a parameter of type specified by type parameter T.

Link copied to clipboard
open infix fun notHaveReturnType(typeFqName: String): FunctionsRuleBuilder

Filters functions not having return type matching typeFqName.

open infix fun notHaveReturnType(type: KClass<*>): FunctionsRuleBuilder

Filters functions not having return type matching type.

Link copied to clipboard
inline fun <T : Any> FunctionsThat.notHaveReturnType(): FunctionsRuleBuilder

Filters functions that do not have return type specified by type parameter T.

Link copied to clipboard
open fun notResideInAModule(vararg modulePaths: String): FunctionsRuleBuilder
open infix fun notResideInAModule(modulePaths: List<String>): FunctionsRuleBuilder

Filters functions not residing in any module matching modulePaths.

open infix fun notResideInAModule(modulePath: String): FunctionsRuleBuilder

Filters functions not residing in a module matching modulePath.

Link copied to clipboard
open fun notResideInAPackage(vararg packagePatterns: String): FunctionsRuleBuilder
open infix fun notResideInAPackage(packagePatterns: List<String>): FunctionsRuleBuilder

Filters functions not residing in any package matching packagePatterns.

open infix fun notResideInAPackage(packagePattern: String): FunctionsRuleBuilder

Filters functions not residing in a package matching packagePattern.

Link copied to clipboard
open infix fun notResideInModule(modulePath: String): FunctionsRuleBuilder

Filters functions not residing in a module matching modulePath.

Link copied to clipboard
open fun notResideInModules(vararg modulePaths: String): FunctionsRuleBuilder
open infix fun notResideInModules(modulePaths: List<String>): FunctionsRuleBuilder

Filters functions not residing in any module matching modulePaths.

Link copied to clipboard
open fun resideInAModule(vararg modulePaths: String): FunctionsRuleBuilder
open infix fun resideInAModule(modulePaths: List<String>): FunctionsRuleBuilder

Filters functions residing in any module matching modulePaths.

open infix fun resideInAModule(modulePath: String): FunctionsRuleBuilder

Filters functions residing in a module matching modulePath.

Link copied to clipboard
open fun resideInAPackage(vararg packagePatterns: String): FunctionsRuleBuilder
open infix fun resideInAPackage(packagePatterns: List<String>): FunctionsRuleBuilder

Filters functions residing in any package matching packagePatterns.

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

Filters functions residing in a package satisfying predicate.

open infix fun resideInAPackage(packagePattern: String): FunctionsRuleBuilder

Filters functions residing in a package matching packagePattern.

Link copied to clipboard
open infix fun resideInModule(modulePath: String): FunctionsRuleBuilder

Filters functions residing in a module matching modulePath.

Link copied to clipboard
open fun resideInModules(vararg modulePaths: String): FunctionsRuleBuilder
open infix fun resideInModules(modulePaths: List<String>): FunctionsRuleBuilder

Filters functions residing in any module matching modulePaths.

Link copied to clipboard
open infix fun resideInPackageOf(type: KClass<*>): FunctionsRuleBuilder

Filters functions residing in the package of type.

Link copied to clipboard
inline fun <T : Any> FunctionsThat.resideInPackageOf(): FunctionsRuleBuilder

Filters functions residing in the package of the type parameter T.

infix fun FunctionsThat.resideInPackageOf(type: KClass<*>): FunctionsRuleBuilder

Filters functions residing in the package of the specified type.

Link copied to clipboard
open infix fun satisfy(predicate: (FunctionDeclarationContext) -> Boolean): FunctionsRuleBuilder

Filters functions satisfying custom context predicate.