io.dropwizard.validation

Annotation Type OneOf

@Target(value={METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
 @Retention(value=RUNTIME)
 @Documented
 @Constraint(validatedBy=OneOfValidator.class)
public @interface OneOf

Checks to see that the value is one of a set of elements.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value The set of valid values.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	groups
boolean	ignoreCase Whether or not to ignore case.
boolean	ignoreWhitespace Whether or not to ignore leading and trailing whitespace.
String	message
Class<? extends javax.validation.Payload>[]	payload

Element Detail

value

public abstract String[] value

The set of valid values.

message

public abstract String message

Default:

"must be one of {value}"

groups

public abstract Class<?>[] groups

Default:

{}

payload

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

Default:

{}

ignoreCase

public abstract boolean ignoreCase

Whether or not to ignore case.

Default:

false

ignoreWhitespace

public abstract boolean ignoreWhitespace

Whether or not to ignore leading and trailing whitespace.

Default:

false