001/* Copyright (C) 2014 konik.io
002 *
003 * This file is part of the Konik library.
004 *
005 * The Konik library is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * The Konik library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with the Konik library. If not, see <http://www.gnu.org/licenses/>.
017 */
018package io.konik.validator.annotation;
019
020import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
021import static java.lang.annotation.ElementType.FIELD;
022import static java.lang.annotation.ElementType.METHOD;
023import static java.lang.annotation.ElementType.PARAMETER;
024import static java.lang.annotation.RetentionPolicy.RUNTIME;
025import io.konik.validator.EmailValidator;
026
027import java.lang.annotation.Documented;
028import java.lang.annotation.Retention;
029import java.lang.annotation.Target;
030
031import javax.validation.Constraint;
032import javax.validation.Payload;
033
034/**
035 * Annotation to validate an email address (by pattern)<br/>
036 */
037@Documented
038@Constraint(validatedBy = EmailValidator.class)
039@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER})
040@Retention(RUNTIME)
041public @interface Email {
042    
043    /**
044     * Groups.
045     *
046     * @return the class[]
047     */
048    Class<?>[] groups() default {};
049
050    /**
051     * Message.
052     *
053     * @return the string
054     */
055    String message() default "{io.konik.validation.constraints.email.message}";
056
057    /**
058     * Payload.
059     *
060     * @return the class<? extends payload>[]
061     */
062    Class<? extends Payload>[] payload() default {};
063}