com.github.robtimus.validation.yearmonth

Annotation Type YearMonthMaxBefore

@Documented
 @Constraint(validatedBy={YearMonthMaxBeforeValidator.ForDate.class,YearMonthMaxBeforeValidator.ForCalendar.class,YearMonthMaxBeforeValidator.ForInstant.class,YearMonthMaxBeforeValidator.ForLocalDate.class,YearMonthMaxBeforeValidator.ForLocalDateTime.class,YearMonthMaxBeforeValidator.ForOffsetDateTime.class,YearMonthMaxBeforeValidator.ForZonedDateTime.class})
 @Target(value={METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
 @Retention(value=RUNTIME)
 @Repeatable(value=YearMonthMaxBefore.List.class)
public @interface YearMonthMaxBefore

Validates that the year-month part of a date/time object is not more than a specific duration before a specific moment in time. More specifically, for a date/time object object, validates that object.yearMonth >= moment - duration.

Supported types are:

• Date
• Calendar
• Instant
• LocalDate
• LocalDateTime
• OffsetDateTime
• ZonedDateTime

null elements are considered valid.

Author:

Rob Spoor

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	duration The maximum amount of time, as an ISO 8601 duration, that the year-month part of a date/time object can be before the value specified in moment().
String	moment The moment against which to validate.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	groups The validation groups.
String	message The error message.
Class<? extends Payload>[]	payload The payload.
String	zoneId The zone id to use.

Element Detail

duration

public abstract String duration

The maximum amount of time, as an ISO 8601 duration, that the year-month part of a date/time object can be before the value specified in moment().

This duration may only have a year and/or month part.

moment

public abstract String moment

The moment against which to validate. This should either be a value that can be parsed to YearMonth, or now to use the current moment in time as defined by the ClockProvider attached to the Validator or ValidatorFactory. The default ClockProvider defines the current time according to the virtual machine, applying the current default time zone if needed.

message

public abstract String message

The error message.

Default:

"{com.github.robtimus.validation.yearmonth.YearMonthMaxBefore.message}"

groups

public abstract Class<?>[] groups

The validation groups.

Default:

{}

payload

public abstract Class<? extends Payload>[] payload

The payload.

Default:

{}

zoneId

public abstract String zoneId

The zone id to use. This should be system for the value returned by ZoneId.systemDefault(), provided for the zone id from the actual value, or otherwise a value that is accepted by ZoneId.of(String) for a specific zone id.

• For Calendar, OffsetDateTime and ZonedDateTime, if the zone id is not provided, the value is converted to the given zone id before extracting the year-month.
• For Date and Instant, no zone id is available, so provided is not allowed.
• For LocalDate and LocalDateTime, no zone id is applicable, so only the default value (system) is allowed.

Default:

"system"