de.malkusch.validation.constraints.upload.Image Maven / Gradle / Ivy

Go to download
package de.malkusch.validation.constraints.upload;

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.imageio.ImageIO;
import javax.validation.Constraint;
import javax.validation.Payload;

import org.springframework.web.multipart.MultipartFile;

import de.malkusch.validation.validator.internal.upload.ImageValidatorForMultipartFile;

/**
 * The MultipartFile must be an image.
 * I.e. the file is readable by {@link ImageIO}
 * 
 * This constraint works only on Spring's {@link MultipartFile}.
 * 
 * @author Markus Malkusch 
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Constraint(validatedBy = ImageValidatorForMultipartFile.class)
@Documented
public @interface Image {

	String message() default "{de.malkusch.validation.constraints.upload.Image.message}";

    Class[] groups() default {};

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