com.opensymphony.xwork2.validator.annotations.ValidationParameter Maven / Gradle / Ivy
/*
* 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;
/**
*
* The ValidationParameter annotation is used as a parameter for CustomValidators.
*
*
* Annotation usage:
*
*
* The annotation must embedded into CustomValidator annotations as a parameter.
*
*
* Annotation parameters:
*
*
*
*
* Parameter
* Required
* Default
* Notes
*
*
* name
* yes
*
* parameter name.
*
*
* value
* yes
*
* parameter value.
*
*
*
*
* Example code:
*
*
*
* @CustomValidator(
* type ="customValidatorName",
* fieldName = "myField",
* parameters = { @ValidationParameter( name = "paramName", value = "paramValue" ) }
* )
*
*
*
* @author jepjep
* @author Rainer Hermanns
*/
@Target( { ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidationParameter {
String name();
String value();
}