config/com.peco2282.devcore.config.validations.annotations

Package-level declarations

Types

Alias

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Alias(val oldName: String)

Specifies an alias for the configuration property.

Clamp

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Clamp(val min: Double, val max: Double)

Clamps a numeric configuration value to the inclusive range from min to max.

ClampAtLeast

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class ClampAtLeast(val value: Double)

Raises a numeric configuration value to value when it is smaller.

ClampAtMost

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class ClampAtMost(val value: Double)

Lowers a numeric configuration value to value when it is larger.

Comment

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

annotation class Comment(val text: String)

Adds a comment to the configuration property.

ConfigIgnore

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

annotation class ConfigIgnore

Excludes a property from configuration reading and writing.

ConfigKey

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class ConfigKey(val value: String)

Specifies the canonical YAML key for a configuration property.

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Email

Validates that the string property value is a valid email address.

FileExists

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class FileExists

Validates that the file path represented by the string property exists on the file system.

Finite

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Finite

Validates that a floating-point value is neither NaN nor infinite. Integral numeric values are always finite.

Max

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Max(val value: Long)

Validates that the numeric property value is at most value.

Min

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Min(val value: Long)

Validates that the numeric property value is at least value.

Negative

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Negative

Validates that the numeric property value is negative (less than zero).

NonNegative

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class NonNegative

Validates that the numeric property value is non-negative (greater than or equal to zero).

NotBlank

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class NotBlank

Validates that the string property value is not blank.

NotEmpty

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class NotEmpty

Validates that the string or collection property value is not empty.

Positive

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Positive

Validates that the numeric property value is positive (greater than zero).

Range

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Range(val min: Long = Long.MIN_VALUE, val max: Long = Long.MAX_VALUE)

Validates that the property value is within the specified min and max range.

Regex

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Regex(val pattern: String)

Validates that the string property value matches the specified regex pattern.

Size

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Size(val min: Int = 0, val max: Int = Int.MAX_VALUE)

Validates that the size of the collection property is within the specified min and max range.

URL

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class URL

Validates that the string property value is a valid URL.