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 the array, map, or collection has the given size. 028 * 029 * For objects of other types the length of their String representation will be checked. 030 * 031 * <br><br> 032 * <b>Note:</b> This constraint is also satisfied when the value to validate is null, therefore you might also need to specified @NotNull 033 * 034 * @author Sebastian Thomschke 035 */ 036 @Documented 037 @Retention(RetentionPolicy.RUNTIME) 038 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) 039 @Constraint(checkWith = SizeCheck.class) 040 public @interface Size 041 { 042 @Documented 043 @Retention(RetentionPolicy.RUNTIME) 044 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) 045 @Constraints 046 public @interface List 047 { 048 /** 049 * The Size constraints. 050 */ 051 Size[] value(); 052 053 /** 054 * Formula returning <code>true</code> if this constraint shall be evaluated and 055 * <code>false</code> if it shall be ignored for the current validation. 056 * <p> 057 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 058 * E.g. <code>groovy:_this.amount > 10</code> 059 * <p> 060 * Available context variables are:<br> 061 * <b>_this</b> -> the validated bean<br> 062 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 063 * or the validated bean for object level constraints) 064 */ 065 String when() default ""; 066 } 067 068 /** 069 * <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. 070 * 071 * <p><b>Default:</b> ConstraintTarget.CONTAINER 072 * 073 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection. 074 */ 075 ConstraintTarget[] appliesTo() default ConstraintTarget.CONTAINER; 076 077 /** 078 * error code passed to the ConstraintViolation object 079 */ 080 String errorCode() default "net.sf.oval.constraint.Size"; 081 082 int max() default Integer.MAX_VALUE; 083 084 /** 085 * message to be used for the ContraintsViolatedException 086 * 087 * @see ConstraintViolation 088 */ 089 String message() default "net.sf.oval.constraint.Size.violated"; 090 091 int min() default 0; 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 * Formula returning <code>true</code> if this constraint shall be evaluated and 116 * <code>false</code> if it shall be ignored for the current validation. 117 * <p> 118 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 119 * E.g. <code>groovy:_this.amount > 10</code> 120 * <p> 121 * Available context variables are:<br> 122 * <b>_this</b> -> the validated bean<br> 123 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 124 * or the validated bean for object level constraints) 125 */ 126 String when() default ""; 127 }