javax.validation.constraints.PastOrPresent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaee-api Show documentation
There is a newer version: 8.0-6
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package javax.validation.constraints;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
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;

/**
 * 
 * Verify that the value of the annotated element is in the past, present or {@code null}.
 * 
 * 
 * Supports:
 * 

 * {@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 java.time.chrono.HijrahDate}
 * {@code java.time.chrono.JapaneseDate}
 * {@code java.time.chrono.MinguoDate}
 * {@code java.time.chrono.ThaiBuddhistDate}
 * 
 * 
 *
 * Other types might be supported in a non-portable manner.
 *
 * @since 2.0
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {})
@Repeatable(PastOrPresent.List.class)
public @interface PastOrPresent {
    String message() default "{javax.validation.constraints.PastOrPresent.message}";

    Class[] groups() default {};

    Class[] payload() default {};

    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        PastOrPresent[] value();
    }
}