kform/tech.ostack.kform.validations/MatchesEmail

MatchesEmail

open class MatchesEmail @JvmOverloads constructor(val code: String = DEFAULT_CODE, val severity: ValidationIssueSeverity = ValidationIssueSeverity.Error, val regex: Regex = EMAIL_REGEX) : Matches(source)

Validation that checks that a string matches an email according to regex (which defaults to EMAIL_REGEX) when it is not empty.

When the string is not empty and does not match an email according to regex, then an issue is emitted with the provided code (defaults to DEFAULT_CODE). This issue contains a value data property with the value that was validated and a pattern data property with the email regular expression that should have been matched.

Parameters

code

Issue code to use when the string is not empty and does not match regex.

severity

Severity of the issue emitted when the string is not empty and does not match regex.

regex

Email regular expression that the string must match, defaults to EMAIL_REGEX.

Constructors

MatchesEmail

@JvmOverloads

constructor(code: String = DEFAULT_CODE, severity: ValidationIssueSeverity = ValidationIssueSeverity.Error, regex: Regex = EMAIL_REGEX)

Types

Companion

object Companion

Properties

code

val code: String

Issue code to use when the string is not empty and does not match regex.

dependencies

open override val dependencies: Map<String, DependencyInfo>

Dependencies of the validation. Mapping of keys to the paths this validation depends on. Keys can be used within a ValidationContext to access the value of the dependencies.

dependsOnDescendants

open val dependsOnDescendants: Boolean

Whether the form manager should reevaluate this validation whenever a descendant of the value being validated changes. This is false by default.

externalContextDependencies

open override val externalContextDependencies: Set<String>

Set of external context dependencies of the validation.

regex

val regex: Regex

Regular expression that the string must match.

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when the string is not empty and does not match regex.

Functions

toString

open override fun toString(): String

validate

open override fun ValidationContext.validate(): Flow<ValidationIssue>

Runs the validation within a ValidationContext containing the value being validated and the value of all declared dependencies. Returns a flow over all found issues.