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 the specified regular expression pattern is matched.
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 = MatchPatternCheck.class)
38  public @interface MatchPattern
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 MatchPattern constraints.
48  		 */
49  		MatchPattern[] 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.VALUES
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.VALUES;
74  
75  	/**
76  	 * error code passed to the ConstraintViolation object
77  	 */
78  	String errorCode() default "net.sf.oval.constraint.MatchPattern";
79  
80  	/**
81  	 *  Match flags, a bit mask that may include
82  	 *         Pattern.CASE_INSENSITIVE, Pattern.MULTILINE, Pattern.DOTALL,
83  	 *         Pattern.UNICODE_CASE, Pattern.CANON_EQ
84  	 *
85  	 * @see java.util.regex.Pattern
86  	 */
87  	int[] flags() default 0;
88  
89  	/**
90  	 * specifies if all of the declared patterns must match or if one is sufficient 
91  	 */
92  	boolean matchAll() default true;
93  
94  	/**
95  	 * message to be used for the ContraintsViolatedException
96  	 * 
97  	 * @see ConstraintViolation
98  	 */
99  	String message() default "net.sf.oval.constraint.MatchPattern.violated";
100 
101 	/**
102 	 * The regular expression(s) to match against
103 	 * <br><br>
104 	 * Examples:<br>
105 	 * decimal number: "^-{0,1}(\\d*|(\\d{1,3}([,]\\d{3})*))[.]?\\d*$"<br>
106 	 * numbers only: "^\\d*$"<br>
107 	 * e-mail address: "^([a-z0-9]{1,}[\\.\\_\\-]?[a-z0-9]{1,})\\@([a-z0-9]{2,}\\.)([a-z]{2,2}|org|net|com|gov|edu|int|info|biz|museum)$"<br>
108 	 * 
109 	 * @see java.util.regex.Pattern
110 	 */
111 	String[] pattern();
112 
113 	/**
114 	 * The associated constraint profiles.
115 	 */
116 	String[] profiles() default {};
117 
118 	/**
119 	 * severity passed to the ConstraintViolation object
120 	 */
121 	int severity() default 0;
122 
123 	/**
124 	 * An expression to specify where in the object graph relative from this object the expression
125 	 * should be applied.
126 	 * <p>
127 	 * Examples:
128 	 * <li>"owner" would apply this constraint to the current object's property <code>owner</code>
129 	 * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code>
130 	 * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied.
131 	 */
132 	String target() default "";
133 
134 	/**
135 	 * Formula returning <code>true</code> if this constraint shall be evaluated and
136 	 * <code>false</code> if it shall be ignored for the current validation.
137 	 * <p>
138 	 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used.
139 	 * E.g. <code>groovy:_this.amount > 10</code>
140 	 * <p>
141 	 * Available context variables are:<br>
142 	 * <b>_this</b> -&gt; the validated bean<br>
143 	 * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
144 	 *    or the validated bean for object level constraints)
145 	 */
146 	String when() default "";
147 }