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