net.sf.oval.guard.Post Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Portions created by Sebastian Thomschke are copyright (c) 2005-2011 Sebastian
 * Thomschke.
 * 
 * All Rights Reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Sebastian Thomschke - initial implementation.
 *******************************************************************************/
package net.sf.oval.guard;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * After the annotated method has been executed the condition is evaluated.

 * 

 * In case of constraint violations the method will throw an ConstraintsViolatedException.
 *
 * @author Sebastian Thomschke
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Post
{
	/**
	 * error code passed to the ConstraintViolation object
	 */
	String errorCode() default "net.sf.oval.guard.Post";

	/**
	 * Formula in the given expression language describing the constraint. the formula must return true if the constraint is satisfied.
	 * 

	 * available variables are:

	 * _args[] -> the current parameter values

	 * _old -> the old values

	 * _returns -> the method's return value
	 * _this -> the validated bean

	 * additionally variables named accordingly to the parameters are available

	 */
	String expr();

	/**
	 * the expression language that is used
	 */
	String lang();

	/**
	 * message to be used for the ContraintsViolatedException
	 * 
	 * @see net.sf.oval.exception.ConstraintsViolatedException
	 */
	String message() default "net.sf.oval.guard.Post.violated";

	/**
	 * Formula that is evaluated prior method execution.

	 * The returned value can later be accessed in the constraint expression via the variable _old
	 */
	String old() default "";

	/**
	 * The associated constraint profiles.
	 */
	String[] profiles() default {};

	/**
	 * severity passed to the ConstraintViolation object
	 */
	int severity() default 0;
}