javax.validation.metadata.ConstraintDescriptor Maven / Gradle / Ivy
/*
* Bean Validation API
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or .
*/
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.ValidationException;
import javax.validation.groups.Default;
import javax.validation.valueextraction.Unwrapping;
/**
* Describes a single constraint and its composing constraints.
*
* @param 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();
/**
* @return a {@link ValidateUnwrappedValue} describing the unwrapping behavior as given
* via the {@link Unwrapping} constraint payloads.
*
* @since 2.0
*/
ValidateUnwrappedValue getValueUnwrapping();
/**
* Returns an instance of the specified type allowing access to provider-specific APIs.
*
* If the Bean Validation provider implementation does not support the specified class,
* a {@link ValidationException} is thrown.
*
* @param type the class of the object to be returned
* @param the type of the object to be returned
* @return an instance of the specified class
* @throws ValidationException if the provider does not support the call
*
* @since 2.0
*/
U unwrap(Class type);
}