javax.validation.Constraint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of validation-api Show documentation

Bean Validation (JSR-303) API.

There is a newer version: 2.0.1.Final

// $Id: Constraint.java 16158 2009-03-15 15:16:05Z epbernard $
/*
* JBoss, Home of Professional Open Source
* Copyright 2008, Red Hat Middleware LLC, 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 javax.validation;

import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
import java.lang.annotation.Annotation;


/**
 * Link between a constraint annotation and its constraint validation implementations.
 * 
 * A given constraint annotation should be annotated by a @Constraint
 * annotation which refers to its list of constraint validation implementations.
 *
 * @author Emmanuel Bernard
 * @author Gavin King
 * @author Hardy Ferentschik
 */
@Documented
@Target({ ANNOTATION_TYPE })
@Retention(RUNTIME)
public @interface Constraint {
    /**
     * ConstraintValidator classes must reference distinct target types.
     * If two validators refer to the same type, an exception will occur.
     *
     * @return array of ConstraintValidator classes implementing the constraint
     */
    public Class>[] validatedBy();
}