net.croz.nrich.validation.api.constraint.MinDate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nrich-validation-api Show documentation
Nrich Validation API
The newest version!
/*
 *  Copyright 2020-2023 CROZ d.o.o, the original author or authors.
 *
 *  Licensed 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
 *
 *      https://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 net.croz.nrich.validation.api.constraint;

import jakarta.validation.Constraint;
import jakarta.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;

/**
 * The annotated element must be after specified minimum date
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(MinDate.List.class)
@Documented
@Constraint(validatedBy = {})
public @interface MinDate {

    String message() default "{nrich.constraint.minDate.invalid.message}";

    Class[] groups() default {};

    Class[] payload() default {};

    /**
     * Minimum date in a string format year-month-day
     *
     * @return String representing minimum date
     */
    String value();


    /**
     * Date format used for parsing. The default used is yyyy-MM-dd
     *
     * @return String representing date format
     */
    String format() default "yyyy-MM-dd";

    /**
     * Defines several {@link MinDate.List} annotations on the same element.
     *
     * @see MinDate.List
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    @interface List {

        MinDate[] value();
    }
}