Package name.matthewgreet.strutscommons.annotation

Annotation Interface Required

@Documented
@Inherited
@Target(FIELD)
@Retention(RUNTIME)
public @interface Required

Defines error message to display if a form field (whether on a Struts Action or model of ModelDriven Struts Action) has not been set.

By default, messages are added to the actionErrors list but this can be overridden by messageType:

ERROR

Message added to Action level error messages. Default.

FIELD

Message added to field error messages.

MESSAGE

Message added to Action level info messages.

WARNING

Message added to Action level warning messages.

Other parameters

message

If not empty string, text message to display. Used if messageKey is not set or finds no message.

messageKey

If not empty string, message key to retrieve from Action's TextProvider. Uses message if no key provided or no message found.

shortCircuit

If true and this validation fails, skips further validation. Defaults to true.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Required.MessageType	Message for any error messages.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	message
String	messageKey
Required.MessageType	messageType
boolean	shortCircuit

Element Details

message

String message

Default:

""

messageKey

String messageKey

Default:

""

messageType

Required.MessageType messageType

Default:

ERROR

shortCircuit

boolean shortCircuit

Default:

true