/*
* Copyright 2002-2006,2009 The Apache Software Foundation.
*
* Licensed 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 -->
* The ValidationParameter annotation is used as a parameter for CustomValidators.
* <!-- END SNIPPET: description -->
*
* <p><u>Annotation usage:</u></p>
*
* <!-- START SNIPPET: usage -->
* <p>The annotation must embedded into CustomValidator annotations as a parameter.</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'>name</td>
* <td class='confluenceTd'>yes</td>
* <td class='confluenceTd'> </td>
* <td class='confluenceTd'>parameter name.</td>
* </tr>
* <tr>
* <td class='confluenceTd'>value</td>
* <td class='confluenceTd'>yes</td>
* <td class='confluenceTd'> </td>
* <td class='confluenceTd'>parameter value.</td>
* </tr>
* </table>
* <!-- END SNIPPET: parameters -->
*
* <p><u>Example code:</u></p>
*
* <pre>
* <!-- START SNIPPET: example -->
* @CustomValidator(
* type ="customValidatorName",
* fieldName = "myField",
* parameters = { @ValidationParameter( name = "paramName", value = "paramValue" ) }
* )
* <!-- END SNIPPET: example -->
* </pre>
*
* @author jepjep
* @author Rainer Hermanns
*/
@Target( { ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidationParameter {
String name();
String value();
}