com.github.robtimus.validation.datetime

Annotation Type MaxBefore

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

Validates that 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 >= moment - duration.

Supported types are:

• Date
• Calendar
• Instant
• LocalDate
• LocalDateTime
• LocalTime
• OffsetDateTime
• OffsetTime
• Year
• YearMonth
• ZonedDateTime

MonthDay is explicitly not supported for the same reason that it implements TemporalAccessor and not Temporal.

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 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.

Element Detail

duration

public abstract String duration

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

The value to validate may impose limitations on the duration. For instance, LocalDate does not allow a time part, and LocalTime does not allow a date part.

moment

public abstract String moment

The moment against which to validate. This should either be a value that can be parsed to the type of value to validate, 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.

For Date, this value will be parsed using DateTimeFormatter.ISO_INSTANT; for Calendar, using DateTimeFormatter.ISO_ZONED_DATE_TIME.

message

public abstract String message

The error message.

Default:

"{com.github.robtimus.validation.datetime.MaxBefore.message}"

groups

public abstract Class<?>[] groups

The validation groups.

Default:

{}

payload

public abstract Class<? extends Payload>[] payload

The payload.

Default:

{}