com.github.ldeitos.constraint.NotEmpty Maven / Gradle / Ivy

Go to download
package com.github.ldeitos.constraint;

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

import com.github.ldeitos.validators.NotEmptyValidator;

/**
 * The annotated element must not empty.
 * 
 * Supported types are:
 * 

 * {@code CharSequence} (length of character sequence is evaluated)
 * {@code Collection} (collection size is evaluated)
 * {@code Map} (map size is evaluated)
 * Array (array length is evaluated)
 * 
 * 
 * {@code null} elements are considered valid.
 *
 * @author Leandro Deitos
 *
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { NotEmptyValidator.class })
public @interface NotEmpty {

	/**
	 * @return Parameter array to be interpolated at message. Parameters can be
	 *         informed in "key=value" or just "value" pattern.

	 *         e.g:

	 * 

	 *         message="My {par1} message"

	 *         messageParameters = {"par1=parameterized"}

	 * 

	 *         message="My {0} message"

	 *         messageParameters = {"parameterized"}
	 */
	String[] messageParameters() default {};

	String message() default "{com.github.ldeitos.NotEmpty.message}";

	Class[] groups() default {};

	Class[] payload() default {};

	/**
	 * Defines several {@link NotEmpty} annotations on the same element.
	 *
	 * @see NotEmpty
	 */
	@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
	@Retention(RUNTIME)
	@Documented
	@interface List {

		NotEmpty[] value();
	}
}