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 value is true.
028     * 
029     * <br><br>
030     * <b>Note:</b> This constraint is also satisified 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 = AssertTrueCheck.class)
038    public @interface AssertTrue
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 AssertTrue constraints.
048                     */
049                    AssertTrue[] 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> -&gt; the validated bean<br>
060                     * <b>_value</b> -&gt; 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.VALUES
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.VALUES;
074    
075            /**
076             * error code passed to the ConstraintViolation object
077             */
078            String errorCode() default "net.sf.oval.constraint.AssertTrue";
079    
080            /**
081             * message to be used for the ContraintsViolatedException
082             * 
083             * @see ConstraintViolation
084             */
085            String message() default "net.sf.oval.constraint.AssertTrue.violated";
086    
087            /**
088             * The associated constraint profiles.
089             */
090            String[] profiles() default {};
091    
092            /**
093             * severity passed to the ConstraintViolation object
094             */
095            int severity() default 0;
096    
097            /**
098             * An expression to specify where in the object graph relative from this object the expression
099             * should be applied.
100             * <p>
101             * Examples:
102             * <li>"owner" would apply this constraint to the current object's property <code>owner</code>
103             * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code>
104             * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied.
105             */
106            String target() default "";
107    
108            /**
109             * Formula returning <code>true</code> if this constraint shall be evaluated and
110             * <code>false</code> if it shall be ignored for the current validation.
111             * <p>
112             * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used.
113             * E.g. <code>groovy:_this.amount > 10</code>
114             * <p>
115             * Available context variables are:<br>
116             * <b>_this</b> -&gt; the validated bean<br>
117             * <b>_value</b> -&gt; the value to validate (e.g. the field value, parameter value, method return value,
118             *    or the validated bean for object level constraints)
119             */
120            String when() default "";
121    }