com.opensymphony.xwork2.validator.annotations

## Annotation Type RequiredStringValidator

-     @Target(value=METHOD)
      @Retention(value=RUNTIME)
      public @interface RequiredStringValidator

  This validator checks that a String field is not empty (i.e. non-null with a length > 0).

  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.
  trim | no | true | Boolean property. Determines whether the String is trimmed before performing the length check.

  Example code:

       @RequiredStringValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true)

  Version:
    $Id$
  Author:
    Rainer Hermanns

- - ### Optional Element Summary

    Optional Elements
    Modifier and Type | Optional Element and Description
    --- | ---
    `String` | `fieldName`
    `String` | `key`
    `String` | `message`
    `String[]` | `messageParams`
    `boolean` | `shortCircuit` If this is activated, the validator will be used as short-circuit.
    `boolean` | `trim` Boolean property.
    `ValidatorType` | `type`

- - ### Element Detail

    - #### trim

          public abstract boolean trim

      Boolean property.
      Returns:
        Determines whether the String is trimmed before performing the length check.
      Default:
        true

    - #### message

          public abstract 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

          public abstract String key

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

    - #### messageParams

          public abstract String[] messageParams

      Returns:
        Additional params to be used to customize message - will be evaluated against the Value Stack
      Default:
        {}

    - #### fieldName

          public abstract String fieldName

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

    - #### shortCircuit

          public abstract 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

          public abstract ValidatorType type

      Returns:
        The validation type for this field/method.
      Default:
        com.opensymphony.xwork2.validator.annotations.ValidatorType.FIELD

Copyright © 2000–2021 Apache Software Foundation. All rights reserved.