Package-level declarations

Utility assertion functions to test validations.

Utility assertion functions to test validations.

Functions

Link copied to clipboard
@JvmName(name = "assertContainsMatchingLocatedIssue")
fun assertContainsMatchingIssue(expectedIssue: LocatedValidationIssue, actualIssues: Iterable<LocatedValidationIssue>, message: String? = null)
@JvmName(name = "assertContainsMatchingLocatedIssue")
suspend fun assertContainsMatchingIssue(expectedIssue: LocatedValidationIssue, actualIssues: Flow<LocatedValidationIssue>, message: String? = null)
fun assertContainsMatchingIssue(expectedIssue: ValidationIssue, actualIssues: Iterable<ValidationIssue>, message: String? = null)
suspend fun assertContainsMatchingIssue(expectedIssue: ValidationIssue, actualIssues: Flow<ValidationIssue>, message: String? = null)

Asserts that actualIssues contains a matching expectedIssue.

Link copied to clipboard
@JvmName(name = "assertContainsMatchingLocatedIssues")
fun assertContainsMatchingIssues(expectedIssues: Iterable<LocatedValidationIssue>, actualIssues: Iterable<LocatedValidationIssue>, message: String? = null)
@JvmName(name = "assertContainsMatchingLocatedIssues")
suspend fun assertContainsMatchingIssues(expectedIssues: Iterable<LocatedValidationIssue>, actualIssues: Flow<LocatedValidationIssue>, message: String? = null)
fun assertContainsMatchingIssues(expectedIssues: Iterable<ValidationIssue>, actualIssues: Iterable<ValidationIssue>, message: String? = null)
suspend fun assertContainsMatchingIssues(expectedIssues: Iterable<ValidationIssue>, actualIssues: Flow<ValidationIssue>, message: String? = null)

Asserts that the actualIssues contains all matching expectedIssues. The order in which the issues appear is not relevant.

Link copied to clipboard
@JvmName(name = "assertMatchingLocatedIssues")
fun assertMatchingIssues(expectedIssues: Iterable<LocatedValidationIssue>, actualIssues: Iterable<LocatedValidationIssue>, message: String? = null)
@JvmName(name = "assertMatchingLocatedIssues")
suspend fun assertMatchingIssues(expectedIssues: Iterable<LocatedValidationIssue>, actualIssues: Flow<LocatedValidationIssue>, message: String? = null)
fun assertMatchingIssues(expectedIssues: Iterable<ValidationIssue>, actualIssues: Iterable<ValidationIssue>, message: String? = null)
suspend fun assertMatchingIssues(expectedIssues: Iterable<ValidationIssue>, actualIssues: Flow<ValidationIssue>, message: String? = null)

Asserts that the expectedIssues match the actualIssues. The order in which the issues appear is not relevant.

Link copied to clipboard
@JvmName(name = "assertNotContainsMatchingLocatedIssue")
fun assertNotContainsMatchingIssue(forbiddenIssue: LocatedValidationIssue, actualIssues: Iterable<LocatedValidationIssue>, message: String? = null)
@JvmName(name = "assertNotContainsMatchingLocatedIssue")
suspend fun assertNotContainsMatchingIssue(forbiddenIssue: LocatedValidationIssue, actualIssues: Flow<LocatedValidationIssue>, message: String? = null)
fun assertNotContainsMatchingIssue(forbiddenIssue: ValidationIssue, actualIssues: Iterable<ValidationIssue>, message: String? = null)
suspend fun assertNotContainsMatchingIssue(forbiddenIssue: ValidationIssue, actualIssues: Flow<ValidationIssue>, message: String? = null)

Asserts that actualIssues does not contain a matching forbiddenIssue.

Link copied to clipboard
@JvmName(name = "assertNotContainsMatchingLocatedIssues")
fun assertNotContainsMatchingIssues(forbiddenIssues: Iterable<LocatedValidationIssue>, actualIssues: Iterable<LocatedValidationIssue>, message: String? = null)
@JvmName(name = "assertNotContainsMatchingLocatedIssues")
suspend fun assertNotContainsMatchingIssues(forbiddenIssues: Iterable<LocatedValidationIssue>, actualIssues: Flow<LocatedValidationIssue>, message: String? = null)
suspend fun assertNotContainsMatchingIssues(forbiddenIssues: Iterable<ValidationIssue>, actualIssues: Flow<ValidationIssue>, message: String? = null)

Asserts that the actualIssues does not contain any matching issues in forbiddenIssues. The order in which the issues appear is not relevant.

Link copied to clipboard
fun <T> runValidation(validation: Validation<T>, value: T, path: String, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null): Flow<ValidationIssue>
fun <T> runValidation(validation: Validation<T>, value: T, path: Path = AbsolutePath.ROOT, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null): Flow<ValidationIssue>

Runs a given validation within a form with a schema of type AnySchema and returns a flow over its issues.

fun <T> runValidation(formSchema: Schema<*>, validation: Validation<T>, value: T, path: String, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null): Flow<ValidationIssue>
fun <T> runValidation(formSchema: Schema<*>, validation: Validation<T>, value: T, path: Path = AbsolutePath.ROOT, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null): Flow<ValidationIssue>

Runs a given validation within a form with schema formSchema and returns a flow over its issues.

Link copied to clipboard
@JvmName(name = "runValidation")
fun <T> runValidationAsync(validation: Validation<T>, value: T, path: String, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null, coroutineScope: CoroutineScope = GlobalScope): CompletableFuture<List<ValidationIssue>>
@JvmName(name = "runValidation")
fun <T> runValidationAsync(validation: Validation<T>, value: T, path: Path = AbsolutePath.ROOT, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null, coroutineScope: CoroutineScope = GlobalScope): CompletableFuture<List<ValidationIssue>>

Runs a given validation within a form with a schema of type AnySchema and returns a future that completes with a list of its issues.

@JvmName(name = "runValidation")
fun <T> runValidationAsync(formSchema: Schema<*>, validation: Validation<T>, value: T, path: String, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null, coroutineScope: CoroutineScope = GlobalScope): CompletableFuture<List<ValidationIssue>>
@JvmName(name = "runValidation")
fun <T> runValidationAsync(formSchema: Schema<*>, validation: Validation<T>, value: T, path: Path = AbsolutePath.ROOT, dependencyValues: Map<String, Any?>? = null, externalContexts: ExternalContexts? = null, coroutineScope: CoroutineScope = GlobalScope): CompletableFuture<List<ValidationIssue>>

Runs a given validation within a form with schema formSchema and returns a future that completes with a list of its issues.