com.github.ldeitos.constraint.AssertFalse Maven / Gradle / Ivy

Go to download
package com.github.ldeitos.constraint;

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.RetentionPolicy.RUNTIME;

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

import javax.validation.Constraint;
import javax.validation.Payload;
import javax.validation.ReportAsSingleViolation;

/**
 * The annotated element must be false.
 * Supported types are {@code boolean} and {@code Boolean}.
 * 
 * {@code null} elements are considered valid.
 *
 * @author Emmanuel Bernard
 */
@javax.validation.constraints.AssertFalse
@Target( { METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Constraint(validatedBy = {})
@ReportAsSingleViolation()
@Documented
public @interface AssertFalse {
	String message() default "{javax.validation.constraints.AssertFalse.message}";
	
	/**
     * @return Parameter array to be interpolated at message. Parameters can be informed in
     * "key=value" or just "value" pattern.

     * e.g:

     * 

     * message="My {par1} message"

     * messageParameters = {"par1=parameterized"}

     * 

     * message="My {0} message"

     * messageParameters = {"parameterized"}
     */
	String[] messageParameters() default {};

    Class[] groups() default {};

    Class[] payload() default {};
    
    /**
     * Defines several {@link AssertFalse} annotations on the same element.
     *
     * @see com.github.ldeitos.constraint.AssertFalse
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        AssertFalse[] value();
    }
}