core/io.github.stefankoppier.openapi.validator.core.rules.primitives/StringRule

StringRule

open class StringRule : ValidationRule<String> (source)

Inheritors

OperationPathRule

Functions

fun alpha(): StringRule

Validate that the element consists only of letters.

fun alphanumeric(): StringRule

Validate that the element consists only of letters or numbers.

fun <R : ValidationRule<String>> R.either(vararg option: String): R

Validate that the element should be equal to one of the elements in option given that it is set.

fun endsWith(suffix: String, ignoreCase: Boolean = false): StringRule

Validate that the element ends with a given suffix.

fun <R : ValidationRule<String>> R.exactly(value: String): R

Validate that the element should be equal to value given that it is set.

fun <R : ValidationRule<String>> R.given(precondition: (String?) -> Boolean, rule: R.() -> R): R

Validate rule only if precondition evaluates to true.

fun <R : ValidationRule<String>> R.holds(message: (String?) -> String = { "Was supposed to hold for '$it' but did not" }, predicate: (String?) -> Boolean): R

Validate that predicate evaluates to true.

fun kebabcase(): StringRule

Validate that the element is kebab case.

fun lowercase(): StringRule

Validate that the element is lowercase.

fun matches(regex: Regex): StringRule

Validate that the element matches regex.

fun <R : ValidationRule<String>> R.not(message: String, rule: R.() -> R): R

Validate that the rule does not hold.

fun numeric(): StringRule

Validate that the element consists only of numbers.

fun <V, R : ValidationRule<String>> R.optional(value: (String?) -> V?, rule: R.() -> R): R

Validate rule only if the evaluated result of value is not null.

fun <R : ValidationRule<String>> R.required(): R

Validate that the element is set.

fun <R : ValidationRule<String>> R.since(date: LocalDate, rule: R.() -> R): R

Validate rule only if date has been in the past.

fun snakecase(): StringRule

Validate that the element is snake case.

fun startsWith(prefix: String, ignoreCase: Boolean = false): StringRule

Validate that the element starts with a given prefix.

fun <R : ValidationRule<String>> R.unspecified(): R

Validate that the element is not set.

fun uppercase(): StringRule

Validate that the element is uppercase.

fun validate(fixture: String?): ValidationResult

Execute the given rule(s) on the fixture.