All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.hibernate.validator.constraints.ScriptAssert Maven / Gradle / Ivy

Go to download

JSR 349's RI, Hibernate Validator version ${hibernate-validator.version} and its dependencies repackaged as OSGi bundle

There is a newer version: 2.5.0-b06
Show newest version
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.hibernate.validator.constraints;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 

* A class-level constraint, that evaluates a script expression against the * annotated element. This constraint can be used to implement validation * routines, that depend on multiple attributes of the annotated element. *

*

* Script expressions can be written in any scripting or expression language, * for which a JSR 223 * ("Scripting for the JavaTM Platform") compatible engine can be * found on the classpath. The following listing shows an example using the * JavaScript engine, which comes with the JDK: *

*

* *

 * {@code @ScriptAssert(lang = "javascript", script = "_this.startDate.before(_this.endDate)")
 * public class CalendarEvent {
 *
 * 	private Date startDate;
 *
 * 	private Date endDate;
 *
 * 	//...
 *
 * }
 * }
 * 
*

* Using a real expression language in conjunction with a shorter object alias * allows for very compact expressions: *

* *
 * {@code @ScriptAssert(lang = "jexl", script = "_.startDate > _.endDate", alias = "_")
 * public class CalendarEvent {
 *
 * 	private Date startDate;
 *
 * 	private Date endDate;
 *
 * 	//...
 *
 * }
 * }
 * 
*

* Accepts any type. *

* * @author Gunnar Morling */ @Target({ TYPE }) @Retention(RUNTIME) @Constraint(validatedBy = { }) @Documented public @interface ScriptAssert { String message() default "{org.hibernate.validator.constraints.ScriptAssert.message}"; Class[] groups() default { }; Class[] payload() default { }; /** * @return The name of the script language used by this constraint as * expected by the JSR 223 {@link javax.script.ScriptEngineManager}. A * {@link javax.validation.ConstraintDeclarationException} will be thrown upon script * evaluation, if no engine for the given language could be found. */ String lang(); /** * @return The script to be executed. The script must return * Boolean.TRUE, if the annotated element could * successfully be validated, otherwise Boolean.FALSE. * Returning null or any type other than Boolean will cause a * {@link javax.validation.ConstraintDeclarationException} upon validation. Any * exception occurring during script evaluation will be wrapped into * a ConstraintDeclarationException, too. Within the script, the * validated object can be accessed from the {@link javax.script.ScriptContext * script context} using the name specified in the * alias attribute. */ String script(); /** * @return The name, under which the annotated element shall be registered * within the script context. Defaults to "_this". */ String alias() default "_this"; /** * Defines several {@code @ScriptAssert} annotations on the same element. */ @Target({ TYPE }) @Retention(RUNTIME) @Documented public @interface List { ScriptAssert[] value(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy