Annotation Interface ShortRangeFieldValidator


@Target(METHOD) @Retention(RUNTIME) public @interface ShortRangeFieldValidator
This validator checks that a numeric field has a value within a specified range. If neither min nor max is set, nothing will be done.

Annotation usage:

The annotation must be applied at method level.

Annotation parameters:

Parameter Required Default Notes
message yes   field error message
key no   i18n key from language specific properties file.
messageParams no   Additional params to be used to customize message - will be evaluated against the Value Stack
fieldName no    
shortCircuit no false If this validator should be used as shortCircuit.
type yes ValidatorType.FIELD Enum value from ValidatorType. Either FIELD or SIMPLE can be used here.
min no   Short property. The minimum the number must be.
minExpression no   OGNL expression used to obtain the minimum the number must be.
max no   Short property. The maximum number can be.
maxExpression no   OGNL expression used to obtain the maximum number can be.
parse no false Enable parsing of min/max value.

If neither min nor max is set, nothing will be done.

The values for min and max must be inserted as String values so that "0" can be handled as a possible value.

Example code:

 
 @IntRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "0", max = "42")

 @IntRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "${minValue}", max = "${maxValue}" parse="true")
 
 
  • Element Details

    • min

      String min
      Short property.
      Returns:
      The minimum the number must be.
      Default:
      ""
    • minExpression

      String minExpression
      Returns:
      The minimum the number must be defined as an expression.
      Default:
      ""
    • max

      String max
      Short property.
      Returns:
      The maximum number can be.
      Default:
      ""
    • maxExpression

      String maxExpression
      Returns:
      The maximum number can be defined as an expression
      Default:
      ""
    • message

      String message
      Returns:
      The default error message for this validator. NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
      Default:
      ""
    • key

      String key
      Returns:
      The message key to lookup for i18n.
      Default:
      ""
    • messageParams

      String[] messageParams
      Returns:
      Additional params to be used to customize message - will be evaluated against the Value Stack
      Default:
      {}
    • fieldName

      String fieldName
      Returns:
      The optional fieldName for SIMPLE validator types.
      Default:
      ""
    • shortCircuit

      boolean shortCircuit
      If this is activated, the validator will be used as short-circuit. Adds the short-circuit="true" attribute value if true.
      Returns:
      true if validator will be used as short-circuit. Default is false.
      Default:
      false
    • type

      Returns:
      The validation type for this field/method.
      Default:
      FIELD