ninja.validation

Annotation Type IsEnum

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface IsEnum

Validates that the field is a valid enum constant. Only needed if you want to customise the validation messages.

Author:

James Moger

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	KEY
static java.lang.String	MESSAGE

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.Class<? extends java.lang.Enum<?>>	enumClass The enum class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	caseSensitive The flag to determine if validation is case-sensitive.
java.lang.String	fieldKey The key for formatting the field
java.lang.String	key The key for the violation message
java.lang.String	message Default message if the key isn't found

Field Detail

KEY

public static final java.lang.String KEY

MESSAGE

public static final java.lang.String MESSAGE

Element Detail

enumClass

public abstract java.lang.Class<? extends java.lang.Enum<?>> enumClass

The enum class.

key

public abstract java.lang.String key

The key for the violation message

Returns:

The key of the violation message

Default:

"validation.is.enum.violation"

message

public abstract java.lang.String message

Default message if the key isn't found

Returns:

The default message

Default:

"{0} is not a valid enum constant"

fieldKey

public abstract java.lang.String fieldKey

The key for formatting the field

Returns:

The key

Default:

""

caseSensitive

public abstract boolean caseSensitive

The flag to determine if validation is case-sensitive.

Returns:

The case-sensitivity flag.

Default:

true