valix-core/io.valix.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class AllowedValues(val value: Array<String>, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Alpha

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Alpha(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

AlphaNumeric

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class AlphaNumeric(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Constraint

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])

annotation class Constraint(val validator: KClass<*>)

Contains

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Contains(val value: String, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Email(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

EndsWith

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class EndsWith(val value: String, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

FieldsMatch

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class FieldsMatch(val first: String, val second: String, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Future

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Future(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

FutureOrPresent

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class FutureOrPresent(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

LowerCase

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class LowerCase(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Max

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Max(val value: Long, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

MaxLength

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class MaxLength(val value: Int, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Min

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Min(val value: Long, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

MinLength

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class MinLength(val value: Int, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Negative

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Negative(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

NegativeOrZero

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class NegativeOrZero(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

NotBlank

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class NotBlank(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

NotEmpty

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class NotEmpty(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

NotNull

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class NotNull(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Past

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Past(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

PastOrPresent

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class PastOrPresent(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Pattern

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Pattern(val regexp: String, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

PhoneNumber

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class PhoneNumber(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Positive

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Positive(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

PositiveOrZero

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class PositiveOrZero(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Range

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Range(val min: Long, val max: Long, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Sensitive

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Sensitive(val mask: String = "********")

Marks a property as containing sensitive data (e.g. passwords, SSNs, credit card numbers).

Size

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Size(val min: Int, val max: Int, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

StartsWith

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class StartsWith(val value: String, val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

UpperCase

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class UpperCase(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Url

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Url(val message: String = "", val messageKey: String = "", val groups: Array<KClass<*>> = [])

Valid

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS])

annotation class Valid

ValidateIf

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class ValidateIf(val field: String, val equals: String = "")

Specifies a conditional check determining whether constraints on the annotated property should be evaluated.

ValixDoc

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class ValixDoc(val displayName: String = "", val description: String = "", val example: String = "")