io.dropwizard.validation

Annotation Type PortRange

@Target(value={METHOD,FIELD,ANNOTATION_TYPE,TYPE_USE})
 @Retention(value=RUNTIME)
 @Constraint(validatedBy=PortRangeValidator.class)
 @Documented
public @interface PortRange

A constraint that allows one to specify a port range, but still allow 0 as the port value to indicate dynamically allocated ports.

Optional Element Summary

Optional Elements

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

Element Detail

min

public abstract int min

The minimum value of the port range the validated int must be in.

Returns:

the minimum value

Default:

1

max

public abstract int max

The maximum value of the port range the validated int must be in.

Returns:

the maximum value

Default:

65535

message

public abstract String message

The validation message for this constraint.

Returns:

the message

Default:

"{org.hibernate.validator.constraints.Range.message}"

groups

public abstract Class<?>[] groups

The groups the constraint belongs to.

Returns:

an array of classes representing the groups

Default:

{}

payload

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

The payloads of this constraint.

Returns:

the array of payload classes

Default:

{}