types/org.kotools.types/EmailAddress/Companion

Companion

object Companion

Contains static declarations for the EmailAddress type.

Properties

Link copied to clipboard
const val PATTERN: String

The pattern that an email address should match.

Functions

Link copied to clipboard
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_3)
fun orNull(text: String): EmailAddress?

Creates an instance of EmailAddress from the specified text, or returns null if the text doesn't match the default pattern.

@ExperimentalSince(version = KotoolsTypesVersion.V4_5_3)
fun orNull(text: String, pattern: String): EmailAddress?

Creates an instance of EmailAddress from the specified text. Returns null if the text doesn't match the specified pattern, or if the pattern doesn't match the default one.

Link copied to clipboard
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_3)
@JvmStatic
fun orThrow(text: String): EmailAddress

Creates an instance of EmailAddress from the specified text, or throws an IllegalArgumentException if the text doesn't match the default pattern.

@ExperimentalSince(version = KotoolsTypesVersion.V4_5_3)
@JvmStatic
fun orThrow(text: String, pattern: String): EmailAddress

Creates an instance of EmailAddress from the specified text. Throws an IllegalArgumentException if the text doesn't match the specified pattern, or if the pattern doesn't match the default one.