001 /******************************************************************************* 002 * Portions created by Sebastian Thomschke are copyright (c) 2005-2011 Sebastian 003 * Thomschke. 004 * 005 * All Rights Reserved. This program and the accompanying materials 006 * are made available under the terms of the Eclipse Public License v1.0 007 * which accompanies this distribution, and is available at 008 * http://www.eclipse.org/legal/epl-v10.html 009 * 010 * Contributors: 011 * Sebastian Thomschke - initial implementation. 012 *******************************************************************************/ 013 package net.sf.oval.constraint; 014 015 import java.lang.annotation.Documented; 016 import java.lang.annotation.ElementType; 017 import java.lang.annotation.Retention; 018 import java.lang.annotation.RetentionPolicy; 019 import java.lang.annotation.Target; 020 021 import net.sf.oval.ConstraintTarget; 022 import net.sf.oval.ConstraintViolation; 023 import net.sf.oval.configuration.annotation.Constraint; 024 import net.sf.oval.configuration.annotation.Constraints; 025 import net.sf.oval.constraint.CheckWithCheck.SimpleCheck; 026 027 /** 028 * Check the value by a method of the same class that takes the value as argument and returns true if valid 029 * and false if invalid. 030 * 031 * @author Sebastian Thomschke 032 */ 033 @Documented 034 @Retention(RetentionPolicy.RUNTIME) 035 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE}) 036 @Constraint(checkWith = CheckWithCheck.class) 037 public @interface CheckWith 038 { 039 @Documented 040 @Retention(RetentionPolicy.RUNTIME) 041 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE}) 042 @Constraints 043 public @interface List 044 { 045 /** 046 * The CheckWith constraints. 047 */ 048 CheckWith[] value(); 049 050 /** 051 * Formula returning <code>true</code> if this constraint shall be evaluated and 052 * <code>false</code> if it shall be ignored for the current validation. 053 * <p> 054 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 055 * E.g. <code>groovy:_this.amount > 10</code> 056 * <p> 057 * Available context variables are:<br> 058 * <b>_this</b> -> the validated bean<br> 059 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 060 * or the validated bean for object level constraints) 061 */ 062 String when() default ""; 063 } 064 065 /** 066 * <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. 067 * 068 * <p><b>Default:</b> ConstraintTarget.CONTAINER 069 * 070 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection. 071 */ 072 ConstraintTarget[] appliesTo() default ConstraintTarget.CONTAINER; 073 074 /** 075 * error code passed to the ConstraintViolation object 076 */ 077 String errorCode() default "net.sf.oval.constraint.CheckWith"; 078 079 /** 080 * this constraint will be ignored if the value to check is null 081 */ 082 boolean ignoreIfNull() default true; 083 084 /** 085 * message to be used for the ContraintsViolatedException 086 * 087 * @see ConstraintViolation 088 */ 089 String message() default "net.sf.oval.constraint.CheckWith.violated"; 090 091 /** 092 * The associated constraint profiles. 093 */ 094 String[] profiles() default {}; 095 096 /** 097 * severity passed to the ConstraintViolation object 098 */ 099 int severity() default 0; 100 101 /** 102 * An expression to specify where in the object graph relative from this object the expression 103 * should be applied. 104 * <p> 105 * Examples: 106 * <li>"owner" would apply this constraint to the current object's property <code>owner</code> 107 * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code> 108 * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied. 109 */ 110 String target() default ""; 111 112 /** 113 * Check class to use for validation. If this class is an inner class 114 * it needs be declared as a <b>static</b> class. Otherwise 115 * check instantiation will fail. 116 * 117 * @see net.sf.oval.constraint.CheckWithCheck.SimpleCheck 118 */ 119 Class< ? extends SimpleCheck> value(); 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> -> the validated bean<br> 130 * <b>_value</b> -> 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 }