Commits

Anonymous committed 4b5cc2d

Fixing Snippets
Issue number:
Obtained from:
Submitted by:
Reviewed by:

git-svn-id: http://svn.opensymphony.com/svn/xwork/trunk@939e221344d-f017-0410-9bd5-d282ab1896d7

Comments (0)

Files changed (16)

tiger/src/java/com/opensymphony/xwork/validator/annotations/ConversionErrorFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The ConversionErrorFieldValidator annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/CustomValidator.java

 
 /**
  * <!-- START SNIPPET: description -->
+ * This annotation can be used for custom validators. Use the ValidationParameter annotation to supply additional params.
  * <!-- END SNIPPET: description -->
  *
  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method or type level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>
  *
  * <pre>
  * <!-- START SNIPPET: example -->
+ * &#64;CustomValidator(type ="customValidatorName", fieldName = "myField")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/DateRangeFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/DoubleRangeFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/EmailValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/ExpressionValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/FieldExpressionValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/IntRangeFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/RegexFieldValidator.java

 
 /**
  * <!-- START SNIPPET: description -->
+ * Validates a string field using a regular expression.
  * <!-- END SNIPPET: description -->
  *
  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>
  *
  * <pre>
  * <!-- START SNIPPET: example -->
+ * &#64;RegexFieldValidator( key = "regex.field", expression = "yourregexp")
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/RequiredFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/RequiredStringValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/StringLengthFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/StringRegexValidator.java

 
 /**
  * <!-- START SNIPPET: description -->
+ * StringRegexValidator checks that a given String field, if not empty,
+ * matches the configured regular expression.
  * <!-- END SNIPPET: description -->
  *
  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/UrlValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>

tiger/src/java/com/opensymphony/xwork/validator/annotations/ValidationParameter.java

 
 /**
  * <!-- START SNIPPET: description -->
+ * The ValidationParameter annotation is used as a parameter for CustomValidators.
  * <!-- END SNIPPET: description -->
  *
  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must embedded into CustomValidator annotations as a parameter.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>
  *
  * <pre>
  * <!-- START SNIPPET: example -->
+ * &#64;CustomValidator(
+ *   type ="customValidatorName",
+ *   fieldName = "myField",
+ *   parameters = { &#64;ValidationParameter( name = "paramName", value = "paramValue" ) }
+ * )
  * <!-- END SNIPPET: example -->
  * </pre>
  *

tiger/src/java/com/opensymphony/xwork/validator/annotations/VisitorFieldValidator.java

  * <p/> <u>Annotation usage:</u>
  *
  * <!-- START SNIPPET: usage -->
- *
+ * <p/>The annotation must be applied at method level.
  * <!-- END SNIPPET: usage -->
  *
  * <p/> <u>Annotation parameters:</u>