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

javax.validation.metadata.ConstraintDescriptor Maven / Gradle / Ivy

The newest version!
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, 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 javax.validation.metadata;

import java.lang.annotation.Annotation;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.validation.ConstraintTarget;
import javax.validation.ConstraintValidator;
import javax.validation.Payload;
import javax.validation.ReportAsSingleViolation;
import javax.validation.groups.Default;

/**
 * Describes a single constraint and its composing constraints.
 * 

* {@code T} is the constraint's annotation type. * * @author Emmanuel Bernard * @author Hardy Ferentschik */ public interface ConstraintDescriptor { /** * Returns the annotation describing the constraint declaration. * If a composing constraint, attribute values are reflecting * the overridden attributes of the composing constraint * * @return the annotation for this constraint */ T getAnnotation(); /** * The non-interpolated error message * * @return the non-interpolated error message * * @since 1.1 */ String getMessageTemplate(); /** * The set of groups the constraint is applied on. * If the constraint declares no group, a set with only the {@link Default} * group is returned. * * @return the groups the constraint is applied on */ Set> getGroups(); /** * The set of payload the constraint hosts. * * @return payload classes hosted on the constraint or an empty set if none */ Set> getPayload(); /** * The {@link ConstraintTarget} value of {@code validationAppliesTo} if the constraint * hosts it or {@code null} otherwise. * * @return the {@code ConstraintTarget} value or {@code null} * * @since 1.1 */ ConstraintTarget getValidationAppliesTo(); /** * List of the constraint validation implementation classes. * * @return list of the constraint validation implementation classes */ List>> getConstraintValidatorClasses(); /** * Returns a map containing the annotation attribute names as keys and the * annotation attribute values as value. *

* If this constraint is used as part of a composed constraint, attribute * values are reflecting the overridden attribute of the composing constraint. * * @return a map containing the annotation attribute names as keys * and the annotation attribute values as value */ Map getAttributes(); /** * Return a set of composing {@link ConstraintDescriptor}s where each * descriptor describes a composing constraint. {@code ConstraintDescriptor} * instances of composing constraints reflect overridden attribute values in * {@link #getAttributes()} and {@link #getAnnotation()}. * * @return a set of {@code ConstraintDescriptor} objects or an empty set * in case there are no composing constraints */ Set> getComposingConstraints(); /** * @return {@code true} if the constraint is annotated with {@link ReportAsSingleViolation} */ boolean isReportAsSingleViolation(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy