io.avaje.validation.constraints.Past Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of avaje-validator-constraints Show documentation

avaje validator constraint annotations

The newest version!

package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * The annotated element must be an instant, date or time in the past.
 *
 * Now is defined by the {@link Clock} Supplier attached to the {@link Validator}. The
 * default clock defines the current time according to the virtual machine, applying the current
 * default time zone if needed.
 *
 * 
Supported types are:
 *
 * 

 *   {@code java.util.Date}
 *   
{@code java.util.Calendar}
 *   
{@code java.time.Instant}
 *   
{@code java.time.LocalDate}
 *   
{@code java.time.LocalDateTime}
 *   
{@code java.time.LocalTime}
 *   
{@code java.time.MonthDay}
 *   
{@code java.time.OffsetDateTime}
 *   
{@code java.time.OffsetTime}
 *   
{@code java.time.Year}
 *   
{@code java.time.YearMonth}
 *   
{@code java.time.ZonedDateTime}
 * 
 *
 * {@code null} elements are considered valid.
 */
@Constraint
@Documented
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface Past {

  String message() default "{avaje.Past.message}";

  Class[] groups() default {};
}