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.CONSTRUCTOR;
022import static java.lang.annotation.ElementType.FIELD;
023import static java.lang.annotation.ElementType.METHOD;
024import static java.lang.annotation.ElementType.PARAMETER;
025import static java.lang.annotation.RetentionPolicy.RUNTIME;
026import io.konik.validator.NullableNotBlankValidator;
027
028import java.lang.annotation.Documented;
029import java.lang.annotation.Retention;
030import java.lang.annotation.Target;
031
032import javax.validation.Constraint;
033import javax.validation.Payload;
034import javax.validation.ReportAsSingleViolation;
035
036/**
037 * When a String is not null it should not be empty nor consists of only whitespaces.
038 * Compared to {@code NotEmpty} this validator will not accept whitespaces as valid.
039 * Compared to {@code NotBlank} this validator will accept null as valid.
040 */
041@Documented
042@Constraint(validatedBy = { NullableNotBlankValidator.class })
043@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
044@Retention(RUNTIME)
045@ReportAsSingleViolation
046public @interface NullableNotBlank {
047
048   /**
049    * Message.
050    *
051    * @return the string
052    */
053   String message() default "{io.konik.validation.constraints.nullablenotblank.message}";
054
055   /**
056    * Groups.
057    *
058    * @return the class<?>[]
059    */
060   Class<?>[] groups() default {};
061
062   /**
063    * Payload.
064    *
065    * @return the class<? extends payload>[]
066    */
067   Class<? extends Payload>[] payload() default {};
068
069   /**
070    * Multiple {@code @NotBlank} annotations on the same element.
071    */
072   @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
073   @Retention(RUNTIME)
074   @Documented
075   public @interface List {
076
077      /**
078       * Value.
079       *
080       * @return the not blank[]
081       */
082      NullableNotBlank[] value();
083   }
084}