soil-form/soil.form.rule

Package-level declarations

Types

ArrayRule

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

ArrayRuleBuilder

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

ArrayRuleTester

class ArrayRuleTester<V>(val predicate: Array<V>.() -> Boolean, val message: () -> String) : ValidationRule<Array<V>>

A rule that tests the array value.

BooleanRule

typealias BooleanRule = ValidationRule<Boolean>

BooleanRuleBuilder

typealias BooleanRuleBuilder = ValidationRuleBuilder<Boolean>

BooleanRuleTester

class BooleanRuleTester(val predicate: Boolean.() -> Boolean, val message: () -> String) : ValidationRule<Boolean>

A rule that tests the boolean value.

CollectionRule

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

CollectionRuleBuilder

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

CollectionRuleTester

class CollectionRuleTester<V>(val predicate: Collection<V>.() -> Boolean, val message: () -> String) : ValidationRule<Collection<V>>

A rule that tests the collection value.

DoubleRule

typealias DoubleRule = ValidationRule<Double>

DoubleRuleBuilder

typealias DoubleRuleBuilder = ValidationRuleBuilder<Double>

DoubleRuleTester

class DoubleRuleTester(val predicate: Double.() -> Boolean, val message: () -> String) : ValidationRule<Double>

A rule that tests the double value.

FloatRule

typealias FloatRule = ValidationRule<Float>

FloatRuleBuilder

typealias FloatRuleBuilder = ValidationRuleBuilder<Float>

FloatRuleTester

class FloatRuleTester(val predicate: Float.() -> Boolean, val message: () -> String) : ValidationRule<Float>

A rule that tests the float value.

IntRule

typealias IntRule = ValidationRule<Int>

IntRuleBuilder

typealias IntRuleBuilder = ValidationRuleBuilder<Int>

IntRuleTester

class IntRuleTester(val predicate: Int.() -> Boolean, val message: () -> String) : ValidationRule<Int>

A rule that tests the integer value.

LongRule

typealias LongRule = ValidationRule<Long>

LongRuleBuilder

typealias LongRuleBuilder = ValidationRuleBuilder<Long>

LongRuleTester

class LongRuleTester(val predicate: Long.() -> Boolean, val message: () -> String) : ValidationRule<Long>

A rule that tests the long value.

ObjectRule

typealias ObjectRule<V> = ValidationRule<V>

ObjectRuleBuilder

typealias ObjectRuleBuilder<V> = ValidationRuleBuilder<V>

ObjectRuleChainer

class ObjectRuleChainer<V, S>(val transform: (V) -> S) : ValidationRule<V>

A rule that chains a transformation function with a set of rules.

ObjectRuleTester

class ObjectRuleTester<V>(val predicate: V.() -> Boolean, val message: () -> String) : ValidationRule<V>

A rule that tests the object value.

OptionalRule

typealias OptionalRule<V> = ValidationRule<V?>

OptionalRuleBuilder

typealias OptionalRuleBuilder<V> = ValidationRuleBuilder<V?>

OptionalRuleChainer

class OptionalRuleChainer<V>(val message: () -> String) : ValidationRule<V?>

A rule that chains non-optional rules. If the value is not null, the rule set is applied to the value.

StringRule

typealias StringRule = ValidationRule<String>

StringRuleBuilder

typealias StringRuleBuilder = ValidationRuleBuilder<String>

StringRuleTester

class StringRuleTester(val predicate: String.() -> Boolean, val message: () -> String) : ValidationRule<String>

A rule that tests the string value.

Functions

cast

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

Chains a transformation function with a set of rules.

isFalse

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

Validates that the boolean value is false.

isNaN

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

Validates that the double value is NaN.

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

Validates that the float value is NaN.

isTrue

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

Validates that the boolean value is true.

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): OptionalRuleChainer<V>

Validates that the optional value is not null.

pattern

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

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

Validates that the string matches the pattern.

test

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

Validates that the object value passes the given predicate.