| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package com.opensymphony.xwork2.validator.annotations; |
| |
| import java.lang.annotation.ElementType; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.lang.annotation.Target; |
| |
| /** |
| * <!-- START SNIPPET: description --> |
| * This annotation has been deprecated since 2.1 as its previous purpose, to define classes that support annotation validations, |
| * is no longer necessary. |
| * <!-- END SNIPPET: description --> |
| * |
| * <p><u>Annotation usage:</u></p> |
| * |
| * <!-- START SNIPPET: usage --> |
| * <p>The Validation annotation must be applied at Type level.</p> |
| * <!-- END SNIPPET: usage --> |
| * |
| * <p><u>Annotation parameters:</u></p> |
| * |
| * <!-- START SNIPPET: parameters --> |
| * <table class='confluenceTable' summary=''> |
| * <tr> |
| * <th class='confluenceTh'> Parameter </th> |
| * <th class='confluenceTh'> Required </th> |
| * <th class='confluenceTh'> Default </th> |
| * <th class='confluenceTh'> Notes </th> |
| * </tr> |
| * <tr> |
| * <td class='confluenceTd'>validations</td> |
| * <td class='confluenceTd'>yes</td> |
| * <td class='confluenceTd'> </td> |
| * <td class='confluenceTd'></td> |
| * </tr> |
| * </table> |
| * <!-- END SNIPPET: parameters --> |
| * |
| * <p><u>Example code:</u></p> |
| * |
| * <u>An Annotated Interface</u> |
| * <pre> |
| * <!-- START SNIPPET: example --> |
| * @Validation() |
| * public interface AnnotationDataAware { |
| * |
| * void setBarObj(Bar b); |
| * |
| * Bar getBarObj(); |
| * |
| * @RequiredFieldValidator(message = "You must enter a value for data.") |
| * @RequiredStringValidator(message = "You must enter a value for data.") |
| * void setData(String data); |
| * |
| * String getData(); |
| * } |
| * <!-- END SNIPPET: example --> |
| * </pre> |
| * |
| * <p><u>Example code:</u></p> |
| * |
| * <u>An Annotated Class</u> |
| * <pre> |
| * <!-- START SNIPPET: example2 --> |
| * @Validation() |
| * public class SimpleAnnotationAction extends ActionSupport { |
| * |
| * @RequiredFieldValidator(type = ValidatorType.FIELD, message = "You must enter a value for bar.") |
| * @IntRangeFieldValidator(type = ValidatorType.FIELD, min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.") |
| * public void setBar(int bar) { |
| * this.bar = bar; |
| * } |
| * |
| * public int getBar() { |
| * return bar; |
| * } |
| * |
| * @Validations( |
| * requiredFields = |
| * {@RequiredFieldValidator(type = ValidatorType.SIMPLE, fieldName = "customfield", message = "You must enter a value for field.")}, |
| * requiredStrings = |
| * {@RequiredStringValidator(type = ValidatorType.SIMPLE, fieldName = "stringisrequired", message = "You must enter a value for string.")}, |
| * emails = |
| * { @EmailValidator(type = ValidatorType.SIMPLE, fieldName = "emailaddress", message = "You must enter a value for email.")}, |
| * urls = |
| * { @UrlValidator(type = ValidatorType.SIMPLE, fieldName = "hreflocation", message = "You must enter a value for email.")}, |
| * stringLengthFields = |
| * {@StringLengthFieldValidator(type = ValidatorType.SIMPLE, trim = true, minLength="10" , maxLength = "12", fieldName = "needstringlength", message = "You must enter a stringlength.")}, |
| * intRangeFields = |
| * { @IntRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "intfield", min = "6", max = "10", message = "bar must be between ${min} and ${max}, current value is ${bar}.")}, |
| * dateRangeFields = |
| * {@DateRangeFieldValidator(type = ValidatorType.SIMPLE, fieldName = "datefield", min = "-1", max = "99", message = "bar must be between ${min} and ${max}, current value is ${bar}.")}, |
| * expressions = { |
| * @ExpressionValidator(expression = "foo > 1", message = "Foo must be greater than Bar 1. Foo = ${foo}, Bar = ${bar}."), |
| * @ExpressionValidator(expression = "foo > 2", message = "Foo must be greater than Bar 2. Foo = ${foo}, Bar = ${bar}."), |
| * @ExpressionValidator(expression = "foo > 3", message = "Foo must be greater than Bar 3. Foo = ${foo}, Bar = ${bar}."), |
| * @ExpressionValidator(expression = "foo > 4", message = "Foo must be greater than Bar 4. Foo = ${foo}, Bar = ${bar}."), |
| * @ExpressionValidator(expression = "foo > 5", message = "Foo must be greater than Bar 5. Foo = ${foo}, Bar = ${bar}.") |
| * } |
| * ) |
| * public String execute() throws Exception { |
| * return SUCCESS; |
| * } |
| * } |
| * |
| * <!-- END SNIPPET: example2 --> |
| * </pre> |
| * |
| * @author Rainer Hermanns |
| * @deprecated Since Struts 2.1 because it isn't necessary anymore |
| */ |
| @Deprecated |
| @Target({ElementType.TYPE}) |
| @Retention(RetentionPolicy.RUNTIME) |
| public @interface Validation { |
| |
| /** |
| * Used for class or interface validation rules. |
| * |
| * @return array of validations |
| */ |
| Validations[] validations() default {}; |
| } |