Modules

Validity is two modules on Maven Central, under the group io.github.soleworks, released together and always at the same version, so a project that uses both never mixes versions:

Module	What it adds	Depends on
`validity-core`	The DSL, the four entries and every constraint but the phone ones	The Kotlin standard library and kotlinx.coroutines
`validity-phone`	`phone`, `mobilePhone`, `countryCode` and `areaCode`, and their messages	`validity-core` and Google’s libphonenumber

Most projects need only validity-core.

Add the dependency

implementation("io.github.soleworks:validity-core")

implementation 'io.github.soleworks:validity-core'

For phone numbers, add validity-phone too, at the same version:

implementation("io.github.soleworks:validity-phone")

implementation 'io.github.soleworks:validity-phone'

Validity is not on Maven Central yet: the first release is on its way. Until it lands, clone the repository next to your project and add includeBuild("../validity") to your settings.gradle.kts. Gradle then builds the dependency from the clone, so the dependency names no version. Maven cannot build from a clone, so a Maven project waits for the release.

Requirements

Java 17+

The JVM the artifacts are compiled for.

Kotlin 2.4

The version Validity is built with. It uses context parameters for its DSL.

Coroutines

kotlinx.coroutines comes with validity-core. You do not need to add it.

Packages and imports

Package	Module	Holds
`io.github.soleworks.validity`	core	`Validatable`, `ContextualValidatable`, `validation`, `validatable`, `required`, `ifPresent`, `forbidden`, the presence rules, `each`, `valid`, `convert`, `metadata`, `Validity`, `ValidationResult`, `Violation`, `ValidationException`, `Messages`
`io.github.soleworks.validity.constraints`	core	The general constraints, `or`, `and`, `not`, `HashAlgorithm`
`io.github.soleworks.validity.constraints.<country>`	core	The constraints of one country: `brazil`, `bulgaria`, `canada`, `france`, `israel`, `netherlands`, `pakistan`, `poland`, `russia`, `slovenia`, `spain`, `thailand`, `ukraine`, `unitedstates`
`io.github.soleworks.validity.phone`	phone	The phone constraints, `PhoneFormat`, `PhoneMessages` and `Messages.phone`

import io.github.soleworks.validity.*                        // Validatable, validation, required, each, ...
import io.github.soleworks.validity.constraints.*            // email, minLength, positive, ...
import io.github.soleworks.validity.constraints.brazil.*     // cpf, cnpj, cep, ...
import io.github.soleworks.validity.phone.*                  // phone, mobilePhone, ... (validity-phone)

Your IDE adds them for you when you complete a constraint.

Why phone numbers are apart

libphonenumber is large and holds the numbering plans of every country. Keeping it out of validity-core means a project that never validates a phone number does not ship it. A module adds its messages to the configuration without the core knowing it, through MessagesKey, the same way your own constraints can.

Versions

Validity follows Semantic Versioning. While the version is 0.x, a breaking change raises the minor version, so moving to the next minor version may ask you to change your code. The changelog says what to change.

Introduction

Declaring a validation

Inside a validation

Your own constraints

Running a validation

Configuration

For AI agents

Add the dependency

Requirements

Java 17+

Kotlin 2.4

Coroutines

Packages and imports

Why phone numbers are apart

Versions

​Add the dependency

​Requirements

Java 17+

Kotlin 2.4

Coroutines

​Packages and imports

​Why phone numbers are apart

​Versions

Add the dependency

Requirements

Packages and imports

Why phone numbers are apart

Versions