1.0.0-alpha11

soil-form/soil.form.core/ValidationRuleBuilder

ValidationRuleBuilder

class ValidationRuleBuilder<V>

A builder class for creating sets of validation rules using a DSL approach.

This builder provides a convenient way to compose multiple validation rules together using a fluent API. It's typically used within validation rule DSL blocks to build complex validation logic from simpler rule components.

Note: Instead of manually creating validation rules with lambda functions, it's recommended to use the type-specific rule extensions available in the soil.form.rule package, which provide convenient DSL methods for common validation scenarios.

Usage:

val stringRules = rules<String> {
    notBlank { "Value is required" }
    minLength(3) { "Must be at least 3 characters" }
    maxLength(100) { "Must be at most 100 characters" }
}

Parameters

V

The type of the value to be validated.

Constructors

ValidationRuleBuilder

constructor()

Functions

fun build(): ValidationRuleSet<V>

Builds and returns the final set of validation rules.

fun <V : Any, S> ObjectRuleBuilder<V>.cast(transform: (V) -> S): ValidationRuleChainer<S>

Creates a transformation-based validation rule chain.

fun <V> ArrayRuleBuilder<V>.element(block: ValidationRuleBuilder<V>.() -> Unit)

Creates a validation rule chain for applying rules to each element of the array.

fun <V> CollectionRuleBuilder<V>.element(block: ValidationRuleBuilder<V>.() -> Unit)

Creates a validation rule chain for applying rules to each element of the collection.

fun <V : Any> ObjectRuleBuilder<V>.equalTo(expected: () -> V, message: () -> String)

Validates that the object value is equal to the expected value.

fun extend(rule: ValidationRule<V>): ValidationRuleBuilder<V>

Adds a validation rule to the set of rules being built.

fun extend(rules: Collection<ValidationRule<V>>): ValidationRuleBuilder<V>

Adds multiple validation rules to the set of rules being built.

fun BooleanRuleBuilder.falsy(message: () -> String)

Validates that the boolean value is false.

fun BooleanRuleBuilder.~~isFalse~~(message: () -> String)

Validates that the boolean value is false.

fun BooleanRuleBuilder.~~isTrue~~(message: () -> String)

Validates that the boolean value is true.

fun StringRuleBuilder.match(pattern: String, message: () -> String)

fun StringRuleBuilder.match(pattern: Regex, message: () -> String)

Validates that the string matches the pattern.

fun DoubleRuleBuilder.maximum(limit: Double, message: () -> String)

Validates that the double value is less than or equal to limit.

fun FloatRuleBuilder.maximum(limit: Float, message: () -> String)

Validates that the float value is less than or equal to limit.

fun IntRuleBuilder.maximum(limit: Int, message: () -> String)

Validates that the integer value is less than or equal to limit.

fun LongRuleBuilder.maximum(limit: Long, message: () -> String)

Validates that the long value is less than or equal to limit.

fun StringRuleBuilder.maxLength(limit: Int, message: () -> String)

Validates that the string length is no more than limit characters.

fun <V> ArrayRuleBuilder<V>.maxSize(limit: Int, message: () -> String)

Validates that the array size is no more than limit.

fun <V> CollectionRuleBuilder<V>.maxSize(limit: Int, message: () -> String)

Validates that the collection size is no more than limit.

fun DoubleRuleBuilder.minimum(limit: Double, message: () -> String)

Validates that the double value is greater than or equal to limit.

fun FloatRuleBuilder.minimum(limit: Float, message: () -> String)

Validates that the float value is greater than or equal to limit.

fun IntRuleBuilder.minimum(limit: Int, message: () -> String)

Validates that the integer value is greater than or equal to limit.

fun LongRuleBuilder.minimum(limit: Long, message: () -> String)

Validates that the long value is greater than or equal to limit.

fun StringRuleBuilder.minLength(limit: Int, message: () -> String)

Validates that the string length is at least limit characters.

fun <V> ArrayRuleBuilder<V>.minSize(limit: Int, message: () -> String)

Validates that the array size is at least limit.

fun <V> CollectionRuleBuilder<V>.minSize(limit: Int, message: () -> String)

Validates that the collection size is at least limit.

fun StringRuleBuilder.notBlank(message: () -> String)

Validates that the string value is not blank.

fun <V> ArrayRuleBuilder<V>.notEmpty(message: () -> String)

Validates that the array is not empty.

fun StringRuleBuilder.notEmpty(message: () -> String)

Validates that the string value is not empty.

fun <V> CollectionRuleBuilder<V>.notEmpty(message: () -> String)

Validates that the collection is not empty.

fun DoubleRuleBuilder.notNaN(message: () -> String)

Validates that the double value is not NaN.

fun FloatRuleBuilder.notNaN(message: () -> String)

Validates that the float value is not NaN.

fun <V : Any> OptionalRuleBuilder<V?>.notNull(message: () -> String): ValidationRuleChainer<V>

Validates that the optional value is not null.

fun StringRuleBuilder.~~pattern~~(pattern: String, message: () -> String)

fun StringRuleBuilder.~~pattern~~(pattern: Regex, message: () -> String)

Validates that the string matches the pattern.

fun <V : Any> ObjectRuleBuilder<V>.satisfy(predicate: V.() -> Boolean, message: () -> String)

Validates that the object value passes the given predicate.

fun <V : Any> ObjectRuleBuilder<V>.~~test~~(predicate: V.() -> Boolean, message: () -> String)

Validates that the object value passes the given predicate.

fun BooleanRuleBuilder.truthy(message: () -> String)

Validates that the boolean value is true.