com.opensymphony.xwork2.validator.annotations.ValidationParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwork Show documentation

XWork is an command-pattern framework that is used to power WebWork as well as other applications. XWork provides an Inversion of Control container, a powerful expression language, data type conversion, validation, and pluggable configuration.

There is a newer version: 2.1.3

Show newest version

/*
 * Copyright (c) 2002-2006 by OpenSymphony
 * All rights reserved.
 */

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();

}