Annotation Interface CustomCollectionPostConversion
@Documented
@Inherited
@Target(FIELD)
@Retention(RUNTIME)
public @interface CustomCollectionPostConversion
Defines a String form field (whether on a Struts Action or model of ModelDriven Struts Action) where the converted
value that is a collection and is to be validated using a client supplied validator and error message to display if
this fails. The custom validator must implement CollectionPostConversionValidator
, preferably extending
AbstractCustomCollectionPostConversionValidatorSupport
, and have a default public constructor.
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.
Other parameters
- message
- If not empty string, text message to display. Used if
messageKey
is empty string 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. - param1
- Parameter recognised by custom validator. Defaults to empty string.
- param2
- Parameter recognised by custom validator. Defaults to empty string.
- param3
- Parameter recognised by custom validator. Defaults to empty string.
- param4
- Parameter recognised by custom validator. Defaults to empty string.
- param5
- Parameter recognised by custom validator. Defaults to empty string.
- shortCircuit
- If true and this validation fails, skips further validation. Defaults to false.
- validatorClass
- Class of client supplied validator. See notes above.
-
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescription -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionboolean
-
Element Details
-
message
String message- Default:
""
-
messageKey
String messageKey- Default:
""
-
messageType
Required.MessageType messageType- Default:
ERROR
-
param1
String param1- Default:
""
-
param2
String param2- Default:
""
-
param3
String param3- Default:
""
-
param4
String param4- Default:
""
-
param5
String param5- Default:
""
-
shortCircuit
boolean shortCircuit- Default:
false
-
validatorClass
Class<? extends CollectionPostConversionValidator<CustomCollectionPostConversion,?>> validatorClass
-