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