Package name.matthewgreet.strutscommons.annotation

Annotation Type Regex

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

Defines error message to display if a String form field (whether on a Struts Action or model of ModelDriven Struts Action) does not match a regular expression.

By default, messages are written as Action error messages for form processing Actions and logged as warnings for viewer Actions but this can be overridden by messageType. For viewer Actions, it's recommended they implement LoggingAware and set a logging message type.

Message Types
DEFAULT Uses default setting of controlling interceptor or library, which is usually Action error messages for form processing Actions and logged as warnings for view ActionsMessage. Default.
ERROR Message added to Action level error messages.
FIELD Message added to field error messages using same name as field.
IGNORE Message is not shown to user or logged. This is not recommended.
LOG_DEBUG Logged to Action's Log4j2 logger (or controlling interceptor's if not available) at DEBUG level.
LOG_ERROR Logged to Action's Log4j2 logger (or controlling interceptor's if not available) at ERROR level.
LOG_INFO Logged to Action's Log4j2 logger (or controlling interceptor's if not available) at INFO level.
LOG_TRACE Logged to Action's Log4j2 logger (or controlling interceptor's if not available) at TRACE level.
LOG_WARN Logged to Action's Log4j2 logger (or controlling interceptor's if not available) at WARN level.
MESSAGE Message added to Action level info messages.
WARNING Message added to Action level warning messages.

Other parameters

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.
regex Regular expression, as defined in Pattern.
shortCircuit If true and this validation fails, skips further validation. Defaults to false.
processNoValue If true, can validate empty string. Defaults to false.

  • Element Details

    • message

      String message
      Default:
      ""

    • messageKey

      String messageKey
      Default:
      ""

    • messageType

      Required.MessageType messageType
      Default:
      DEFAULT

    • regex

      String regex

    • shortCircuit

      boolean shortCircuit
      Default:
      false

    • processNoValue

      boolean processNoValue
      Default:
      false