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 value equals the value of the referenced field. 028 * 029 * <br><br> 030 * <b>Note:</b> This constraint is also satisfied when the value to validate is null, therefore you might also need to specified @NotNull 031 * 032 * @author Sebastian Thomschke 033 */ 034 @Documented 035 @Retention(RetentionPolicy.RUNTIME) 036 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) 037 @Constraint(checkWith = EqualToFieldCheck.class) 038 public @interface EqualToField 039 { 040 @Documented 041 @Retention(RetentionPolicy.RUNTIME) 042 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) 043 @Constraints 044 public @interface List 045 { 046 /** 047 * The EqualToField constraints. 048 */ 049 EqualToField[] value(); 050 051 /** 052 * Formula returning <code>true</code> if this constraint shall be evaluated and 053 * <code>false</code> if it shall be ignored for the current validation. 054 * <p> 055 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 056 * E.g. <code>groovy:_this.amount > 10</code> 057 * <p> 058 * Available context variables are:<br> 059 * <b>_this</b> -> the validated bean<br> 060 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 061 * or the validated bean for object level constraints) 062 */ 063 String when() default ""; 064 } 065 066 /** 067 * <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. 068 * 069 * <p><b>Default:</b> ConstraintTarget.CONTAINER 070 * 071 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection. 072 */ 073 ConstraintTarget[] appliesTo() default ConstraintTarget.CONTAINER; 074 075 /** 076 * The class in which the field is declared. If omitted the current class and it's super classes are searched for a field with the given name. 077 * The default value Void.class means the current class. 078 */ 079 Class< ? > declaringClass() default Void.class; 080 081 /** 082 * error code passed to the ConstraintViolation object 083 */ 084 String errorCode() default "net.sf.oval.constraint.EqualToField"; 085 086 /** 087 * message to be used for the ContraintsViolatedException 088 * 089 * @see ConstraintViolation 090 */ 091 String message() default "net.sf.oval.constraint.EqualToField.violated"; 092 093 /** 094 * The associated constraint profiles. 095 */ 096 String[] profiles() default {}; 097 098 /** 099 * severity passed to the ConstraintViolation object 100 */ 101 int severity() default 0; 102 103 /** 104 * An expression to specify where in the object graph relative from this object the expression 105 * should be applied. 106 * <p> 107 * Examples: 108 * <li>"owner" would apply this constraint to the current object's property <code>owner</code> 109 * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code> 110 * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied. 111 */ 112 String target() default ""; 113 114 /** 115 * if set to true the field's value will be retrieved via 116 * the corresponding getter method instead of reflection 117 */ 118 boolean useGetter() default false; 119 120 /** 121 * name of the field 122 */ 123 String value(); 124 125 /** 126 * Formula returning <code>true</code> if this constraint shall be evaluated and 127 * <code>false</code> if it shall be ignored for the current validation. 128 * <p> 129 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 130 * E.g. <code>groovy:_this.amount > 10</code> 131 * <p> 132 * Available context variables are:<br> 133 * <b>_this</b> -> the validated bean<br> 134 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 135 * or the validated bean for object level constraints) 136 */ 137 String when() default ""; 138 }