View Javadoc
1   /*******************************************************************************
2    * Portions created by Sebastian Thomschke are copyright (c) 2005-2011 Sebastian
3    * Thomschke.
4    * 
5    * All Rights Reserved. This program and the accompanying materials
6    * are made available under the terms of the Eclipse Public License v1.0
7    * which accompanies this distribution, and is available at
8    * http://www.eclipse.org/legal/epl-v10.html
9    * 
10   * Contributors:
11   *     Sebastian Thomschke - initial implementation.
12   *******************************************************************************/
13  package net.sf.oval.constraint;
14  
15  import java.lang.annotation.Documented;
16  import java.lang.annotation.ElementType;
17  import java.lang.annotation.Retention;
18  import java.lang.annotation.RetentionPolicy;
19  import java.lang.annotation.Target;
20  
21  import net.sf.oval.ConstraintTarget;
22  import net.sf.oval.ConstraintViolation;
23  import net.sf.oval.configuration.annotation.Constraint;
24  import net.sf.oval.configuration.annotation.Constraints;
25  
26  /**
27   * Check if value equals the value of the referenced field.
28   * 
29   * <br><br>
30   * <b>Note:</b> This constraint is also satisfied when the value to validate is null, therefore you might also need to specified @NotNull
31   * 
32   * @author Sebastian Thomschke
33   */
34  @Documented
35  @Retention(RetentionPolicy.RUNTIME)
36  @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
37  @Constraint(checkWith = EqualToFieldCheck.class)
38  public @interface EqualToField
39  {
40  	@Documented
41  	@Retention(RetentionPolicy.RUNTIME)
42  	@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
43  	@Constraints
44  	public @interface List
45  	{
46  		/**
47  		 * The EqualToField constraints.
48  		 */
49  		EqualToField[] value();
50  
51  		/**
52  		 * Formula returning <code>true</code> if this constraint shall be evaluated and
53  		 * <code>false</code> if it shall be ignored for the current validation.
54  		 * <p>
55  		 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used.
56  		 * E.g. <code>groovy:_this.amount > 10</code>
57  		 * <p>
58  		 * Available context variables are:<br>
59  		 * <b>_this</b> -&gt; the validated bean<br>
60  		 * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
61  		 *    or the validated bean for object level constraints)
62  		 */
63  		String when() default "";
64  	}
65  
66  	/**
67  	 * <p>In case the constraint is declared for an array, collection or map this controls how the constraint is applied to it and it's child objects.
68  	 * 
69  	 * <p><b>Default:</b> ConstraintTarget.CONTAINER
70  	 * 
71  	 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection.
72  	 */
73  	ConstraintTarget[] appliesTo() default ConstraintTarget.CONTAINER;
74  
75  	/**
76  	 * The class in which the field is declared. If omitted the current class and it's super classes are searched for a field with the given name.
77  	 * The default value Void.class means the current class.
78  	 */
79  	Class< ? > declaringClass() default Void.class;
80  
81  	/**
82  	 * error code passed to the ConstraintViolation object
83  	 */
84  	String errorCode() default "net.sf.oval.constraint.EqualToField";
85  
86  	/**
87  	 * message to be used for the ContraintsViolatedException
88  	 * 
89  	 * @see ConstraintViolation
90  	 */
91  	String message() default "net.sf.oval.constraint.EqualToField.violated";
92  
93  	/**
94  	 * The associated constraint profiles.
95  	 */
96  	String[] profiles() default {};
97  
98  	/**
99  	 * severity passed to the ConstraintViolation object
100 	 */
101 	int severity() default 0;
102 
103 	/**
104 	 * An expression to specify where in the object graph relative from this object the expression
105 	 * should be applied.
106 	 * <p>
107 	 * Examples:
108 	 * <li>"owner" would apply this constraint to the current object's property <code>owner</code>
109 	 * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code>
110 	 * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied.
111 	 */
112 	String target() default "";
113 
114 	/**
115 	 * if set to true the field's value will be retrieved via
116 	 * the corresponding getter method instead of reflection 
117 	 */
118 	boolean useGetter() default false;
119 
120 	/**
121 	 * name of the field
122 	 */
123 	String value();
124 
125 	/**
126 	 * Formula returning <code>true</code> if this constraint shall be evaluated and
127 	 * <code>false</code> if it shall be ignored for the current validation.
128 	 * <p>
129 	 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used.
130 	 * E.g. <code>groovy:_this.amount > 10</code>
131 	 * <p>
132 	 * Available context variables are:<br>
133 	 * <b>_this</b> -&gt; the validated bean<br>
134 	 * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
135 	 *    or the validated bean for object level constraints)
136 	 */
137 	String when() default "";
138 }