01: /*******************************************************************************
02: * Portions created by Sebastian Thomschke are copyright (c) 2005-2007 Sebastian
03: * Thomschke.
04: *
05: * All Rights Reserved. This program and the accompanying materials
06: * are made available under the terms of the Eclipse Public License v1.0
07: * which accompanies this distribution, and is available at
08: * http://www.eclipse.org/legal/epl-v10.html
09: *
10: * Contributors:
11: * Sebastian Thomschke - initial implementation.
12: *******************************************************************************/package net.sf.oval.constraint;
13:
14: import java.lang.annotation.Documented;
15: import java.lang.annotation.ElementType;
16: import java.lang.annotation.Retention;
17: import java.lang.annotation.RetentionPolicy;
18: import java.lang.annotation.Target;
19:
20: import net.sf.oval.ConstraintViolation;
21: import net.sf.oval.configuration.annotation.Constraint;
22:
23: /**
24: * Check the value by a method of the same class that takes the value as argument and returns true if valid
25: * and false if invalid<br>
26: *
27: * @author Sebastian Thomschke
28: */
29: @Documented
30: @Retention(RetentionPolicy.RUNTIME)
31: @Target({ElementType.FIELD,ElementType.PARAMETER,ElementType.METHOD,ElementType.TYPE})
32: @Constraint(checkWith=ValidateWithMethodCheck.class)
33: public @interface ValidateWithMethod {
34: /**
35: * error code passed to the ConstraintViolation object
36: */
37: String errorCode() default "net.sf.oval.constraints.ValidateWithMethod";
38:
39: /**
40: * this constraint will be ignored if the value to check is null
41: */
42: boolean ignoreIfNull() default true;
43:
44: /**
45: * message to be used for the ContraintsViolatedException
46: *
47: * @see ConstraintViolation
48: */
49: String message() default "net.sf.oval.constraints.ValidateWithMethod.violated";
50:
51: /**
52: * name a the single parameter method to use for validation
53: */
54: String methodName();
55:
56: /**
57: * type of the method parameter
58: */
59: Class parameterType();
60:
61: /**
62: * severity passed to the ConstraintViolation object
63: */
64: int severity() default 0;
65:
66: /**
67: * The associated validation profiles.
68: */
69: String[] profiles() default {};
70: }
|