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 026 /** 027 * Check if evaluating the expression in the specified expression language returns true. 028 * 029 * @author Sebastian Thomschke 030 */ 031 @Documented 032 @Retention(RetentionPolicy.RUNTIME) 033 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE}) 034 @Constraint(checkWith = AssertCheck.class) 035 public @interface Assert 036 { 037 @Documented 038 @Retention(RetentionPolicy.RUNTIME) 039 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE}) 040 @Constraints 041 public @interface List 042 { 043 /** 044 * The Assert constraints. 045 */ 046 Assert[] value(); 047 048 /** 049 * Formula returning <code>true</code> if this constraint shall be evaluated and 050 * <code>false</code> if it shall be ignored for the current validation. 051 * <p> 052 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 053 * E.g. <code>groovy:_this.amount > 10</code> 054 * <p> 055 * Available context variables are:<br> 056 * <b>_this</b> -> the validated bean<br> 057 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 058 * or the validated bean for object level constraints) 059 */ 060 String when() default ""; 061 } 062 063 /** 064 * <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. 065 * 066 * <p><b>Default:</b> ConstraintTarget.CONTAINER 067 * 068 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection. 069 */ 070 ConstraintTarget[] appliesTo() default ConstraintTarget.CONTAINER; 071 072 /** 073 * failure code passed to the ConstraintViolation object 074 */ 075 String errorCode() default "net.sf.oval.constraint.Assert"; 076 077 /** 078 * Formula in the given expression language describing the constraint. 079 * The formula must return <code>true</code> if the constraint is satisfied. 080 * <p> 081 * Available context variables are:<br> 082 * <b>_this</b> -> the validated bean<br> 083 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 084 * or the validated bean for object level constraints) 085 */ 086 String expr(); 087 088 /** 089 * the expression language that is used, e.g. "bsh" / "beanshell", "groovy", or "js" / "javascript". 090 */ 091 String lang(); 092 093 /** 094 * message to be used for constructing the ConstraintViolation object 095 * 096 * @see ConstraintViolation 097 */ 098 String message() default "net.sf.oval.constraint.Assert.violated"; 099 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> -> 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 }