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 evaluating the expression in the specified expression language returns true.
28   * 
29   * @author Sebastian Thomschke
30   */
31  @Documented
32  @Retention(RetentionPolicy.RUNTIME)
33  @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE})
34  @Constraint(checkWith = AssertCheck.class)
35  public @interface Assert
36  {
37  	@Documented
38  	@Retention(RetentionPolicy.RUNTIME)
39  	@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE})
40  	@Constraints
41  	public @interface List
42  	{
43  		/**
44  		 * The Assert constraints.
45  		 */
46  		Assert[] value();
47  
48  		/**
49  		 * Formula returning <code>true</code> if this constraint shall be evaluated and
50  		 * <code>false</code> if it shall be ignored for the current validation.
51  		 * <p>
52  		 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used.
53  		 * E.g. <code>groovy:_this.amount > 10</code>
54  		 * <p>
55  		 * Available context variables are:<br>
56  		 * <b>_this</b> -&gt; the validated bean<br>
57  		 * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
58  		 *    or the validated bean for object level constraints)
59  		 */
60  		String when() default "";
61  	}
62  
63  	/**
64  	 * <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.
65  	 * 
66  	 * <p><b>Default:</b> ConstraintTarget.CONTAINER
67  	 * 
68  	 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection.
69  	 */
70  	ConstraintTarget[] appliesTo() default ConstraintTarget.CONTAINER;
71  
72  	/**
73  	 * failure code passed to the ConstraintViolation object
74  	 */
75  	String errorCode() default "net.sf.oval.constraint.Assert";
76  
77  	/**
78  	 * Formula in the given expression language describing the constraint.
79  	 * The formula must return <code>true</code> if the constraint is satisfied.
80  	 * <p>
81  	 * Available context variables are:<br>
82  	 * <b>_this</b> -&gt; the validated bean<br>
83  	 * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
84  	 *    or the validated bean for object level constraints)
85  	 */
86  	String expr();
87  
88  	/**
89  	 * the expression language that is used, e.g. "bsh" / "beanshell", "groovy", or "js" / "javascript".
90  	 */
91  	String lang();
92  
93  	/**
94  	 * message to be used for constructing the ConstraintViolation object
95  	 * 
96  	 * @see ConstraintViolation
97  	 */
98  	String message() default "net.sf.oval.constraint.Assert.violated";
99  
100 	/**
101 	 * The associated constraint profiles.
102 	 */
103 	String[] profiles() default {};
104 
105 	/**
106 	 * severity passed to the ConstraintViolation object
107 	 */
108 	int severity() default 0;
109 
110 	/**
111 	 * An expression to specify where in the object graph relative from this object the expression
112 	 * should be applied.
113 	 * <p>
114 	 * Examples:
115 	 * <li>"owner" would apply this constraint to the current object's property <code>owner</code>
116 	 * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code>
117 	 * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied.
118 	 */
119 	String target() default "";
120 
121 	/**
122 	 * Formula returning <code>true</code> if this constraint shall be evaluated and
123 	 * <code>false</code> if it shall be ignored for the current validation.
124 	 * <p>
125 	 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used.
126 	 * E.g. <code>groovy:_this.amount > 10</code>
127 	 * <p>
128 	 * Available context variables are:<br>
129 	 * <b>_this</b> -&gt; the validated bean<br>
130 	 * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
131 	 *    or the validated bean for object level constraints)
132 	 */
133 	String when() default "";
134 }