soil-form/soil.form.rule

Package-level declarations

Types

ArrayRule

typealias ArrayRule<V> = ValidationRule<Array<V>>

A type alias for validation rules that operate on Array values.

ArrayRuleBuilder

typealias ArrayRuleBuilder<V> = ValidationRuleBuilder<Array<V>>

A type alias for builders that create Array validation rules.

ArrayRuleTester

class ~~ArrayRuleTester~~<V>(predicate: Array<V>.() -> Boolean, message: () -> String) : Function1<value: Array<V>, ValidationResult>

BooleanRule

typealias BooleanRule = ValidationRule<Boolean>

A type alias for validation rules that operate on Boolean values.

BooleanRuleBuilder

typealias BooleanRuleBuilder = ValidationRuleBuilder<Boolean>

A type alias for builders that create Boolean validation rules.

BooleanRuleTester

class ~~BooleanRuleTester~~(predicate: Boolean.() -> Boolean, message: () -> String) : Function1<value: Boolean, ValidationResult>

CollectionRule

typealias CollectionRule<V> = ValidationRule<Collection<V>>

A type alias for validation rules that operate on Collection values.

CollectionRuleBuilder

typealias CollectionRuleBuilder<V> = ValidationRuleBuilder<Collection<V>>

A type alias for builders that create Collection validation rules.

CollectionRuleTester

class ~~CollectionRuleTester~~<V>(predicate: Collection<V>.() -> Boolean, message: () -> String) : Function1<value: Collection<V>, ValidationResult>

DoubleRule

typealias DoubleRule = ValidationRule<Double>

A type alias for validation rules that operate on Double values.

DoubleRuleBuilder

typealias DoubleRuleBuilder = ValidationRuleBuilder<Double>

A type alias for builders that create Double validation rules.

DoubleRuleTester

class ~~DoubleRuleTester~~(predicate: Double.() -> Boolean, message: () -> String) : Function1<value: Double, ValidationResult>

FloatRule

typealias FloatRule = ValidationRule<Float>

A type alias for validation rules that operate on Float values.

FloatRuleBuilder

typealias FloatRuleBuilder = ValidationRuleBuilder<Float>

A type alias for builders that create Float validation rules.

FloatRuleTester

class ~~FloatRuleTester~~(predicate: Float.() -> Boolean, message: () -> String) : Function1<value: Float, ValidationResult>

IntRule

typealias IntRule = ValidationRule<Int>

A type alias for validation rules that operate on Int values.

IntRuleBuilder

typealias IntRuleBuilder = ValidationRuleBuilder<Int>

A type alias for builders that create Int validation rules.

IntRuleTester

class ~~IntRuleTester~~(predicate: Int.() -> Boolean, message: () -> String) : Function1<value: Int, ValidationResult>

LongRule

typealias LongRule = ValidationRule<Long>

A type alias for validation rules that operate on Long values.

LongRuleBuilder

typealias LongRuleBuilder = ValidationRuleBuilder<Long>

A type alias for builders that create Long validation rules.

LongRuleTester

class ~~LongRuleTester~~(predicate: Long.() -> Boolean, message: () -> String) : Function1<value: Long, ValidationResult>

ObjectRule

typealias ObjectRule<V> = ValidationRule<V>

A type alias for validation rules that operate on any object type.

ObjectRuleBuilder

typealias ObjectRuleBuilder<V> = ValidationRuleBuilder<V>

A type alias for builders that create object validation rules.

ObjectRuleTester

class ~~ObjectRuleTester~~<V>(predicate: V.() -> Boolean, message: () -> String) : Function1<value: V, ValidationResult>

OptionalRule

typealias OptionalRule<V> = ValidationRule<V?>

A type alias for validation rules that operate on optional (nullable) values.

OptionalRuleBuilder

typealias OptionalRuleBuilder<V> = ValidationRuleBuilder<V?>

A type alias for builders that create optional validation rules.

StringRule

typealias StringRule = ValidationRule<String>

A type alias for validation rules that operate on String values.

StringRuleBuilder

typealias StringRuleBuilder = ValidationRuleBuilder<String>

A type alias for builders that create String validation rules.

StringRuleTester

class ~~StringRuleTester~~(predicate: String.() -> Boolean, message: () -> String) : Function1<value: String, ValidationResult>

Functions

ArrayRule

fun <V> ArrayRule(predicate: Array<V>.() -> Boolean, message: () -> String): ArrayRule<V>

A rule that tests the array value.

BooleanRule

fun BooleanRule(predicate: Boolean.() -> Boolean, message: () -> String): BooleanRule

A rule that tests the boolean value.

cast

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

Creates a transformation-based validation rule chain.

CollectionRule

fun <V> CollectionRule(predicate: Collection<V>.() -> Boolean, message: () -> String): CollectionRule<V>

A rule that tests the collection value.

DoubleRule

fun DoubleRule(predicate: Double.() -> Boolean, message: () -> String): DoubleRule

A rule that tests the double value.

element

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.

equalTo

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

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

falsy

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

Validates that the boolean value is false.

FloatRule

fun FloatRule(predicate: Float.() -> Boolean, message: () -> String): FloatRule

A rule that tests the float value.

IntRule

fun IntRule(predicate: Int.() -> Boolean, message: () -> String): IntRule

A rule that tests the integer value.

isFalse

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

Validates that the boolean value is false.

isTrue

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

Validates that the boolean value is true.

LongRule

fun LongRule(predicate: Long.() -> Boolean, message: () -> String): LongRule

A rule that tests the long value.

match

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

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

Validates that the string matches the pattern.

maximum

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.

maxLength

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

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

maxSize

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.

minimum

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.

minLength

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

Validates that the string length is at least limit characters.

minSize

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.

notBlank

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

Validates that the string value is not blank.

notEmpty

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.

notNaN

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.

notNull

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

Validates that the optional value is not null.

ObjectRule

fun <V> ObjectRule(predicate: V.() -> Boolean, message: () -> String): ObjectRule<V>

A rule that tests the object value.

pattern

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

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

Validates that the string matches the pattern.

satisfy

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

Validates that the object value passes the given predicate.

StringRule

fun StringRule(predicate: String.() -> Boolean, message: () -> String): StringRule

A rule that tests the string value.

test

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

Validates that the object value passes the given predicate.

truthy

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

Validates that the boolean value is true.