Package io.dropwizard.validation

Annotation Type DataSizeRange

@Documented
@Constraint(validatedBy={})
@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
@Retention(RUNTIME)
@MinDataSize(0L)
@MaxDataSize(value=9223372036854775807L,
             unit=PEBIBYTES)
@ReportAsSingleViolation
public @interface DataSizeRange

The annotated element has to be in the appropriate range. Apply on DataSize instances.

Since:

2.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	groups	The groups the constraint belongs to.
long	max	The maximum value of the range the validated DataSize must be in.
String	message	The validation message for this constraint.
long	min	The minimum value of the range the validated DataSize must be in.
Class<? extends javax.validation.Payload>[]	payload	The payloads of this constraint.
DataSizeUnit	unit	The unit of the validated range.

Element Detail

min

@OverridesAttribute(constraint=MinDataSize.class,
                    name="value")
long min

The minimum value of the range the validated DataSize must be in.

Returns:

the minimum value

Default:

0L

max

@OverridesAttribute(constraint=MaxDataSize.class,
                    name="value")
long max

The maximum value of the range the validated DataSize must be in.

Returns:

the maximum value

Default:

9223372036854775807L

unit

@OverridesAttribute(constraint=MinDataSize.class,name="unit") @OverridesAttribute(constraint=MaxDataSize.class,name="unit")
DataSizeUnit unit

The unit of the validated range.

Returns:

the DataSizeUnit

Default:

io.dropwizard.util.DataSizeUnit.BYTES

message

String message

The validation message for this constraint.

Returns:

the message

Default:

"must be between {min} {unit} and {max} {unit}"

groups

Class<?>[] groups

The groups the constraint belongs to.

Returns:

an array of classes representing the groups

Default:

{}

payload

Class<? extends javax.validation.Payload>[] payload

The payloads of this constraint.

Returns:

the array of payload classes

Default:

{}