package io.dropwizard.validation;
import io.dropwizard.util.DataSizeUnit;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
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.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
The annotated element must be a DataSize
whose value must be less than or equal to the specified maximum.
null
elements are considered valid
Since: 2.0
/**
* The annotated element must be a {@link io.dropwizard.util.DataSize}
* whose value must be less than or equal to the specified maximum.
* <p/>
* <code>null</code> elements are considered valid
*
* @since 2.0
*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = MaxDataSizeValidator.class)
public @interface MaxDataSize {
String message() default "must be less than or equal to {value} {unit}";
Class<?>[] groups() default {};
@SuppressWarnings("UnusedDeclaration") Class<? extends Payload>[] payload() default {};
Returns: value the element must be less than or equal to
/**
* @return value the element must be less than or equal to
*/
long value();
Returns: unit of the value the element must be less than or equal to
/**
* @return unit of the value the element must be less than or equal to
*/
DataSizeUnit unit() default DataSizeUnit.BYTES;
}