Package javax.validation.metadata
Interface ConstraintDescriptor<T extends java.lang.annotation.Annotation>
-
public interface ConstraintDescriptor<T extends java.lang.annotation.Annotation>
Describes a single constraint and its composing constraints.T
is the constraint's annotation type.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description T
getAnnotation()
Returns the annotation describing the constraint declaration.java.util.Map<java.lang.String,java.lang.Object>
getAttributes()
Returns a map containing the annotation attribute names as keys and the annotation attribute values as value.java.util.Set<ConstraintDescriptor<?>>
getComposingConstraints()
Return a set of composingConstraintDescriptor
s where each descriptor describes a composing constraint.java.util.List<java.lang.Class<? extends ConstraintValidator<T,?>>>
getConstraintValidatorClasses()
List of the constraint validation implementation classes.java.util.Set<java.lang.Class<?>>
getGroups()
The set of groups the constraint is applied on.java.lang.String
getMessageTemplate()
The non-interpolated error messagejava.util.Set<java.lang.Class<? extends Payload>>
getPayload()
The set of payload the constraint hosts.ConstraintTarget
getValidationAppliesTo()
boolean
isReportAsSingleViolation()
-
-
-
Method Detail
-
getAnnotation
T getAnnotation()
Returns the annotation describing the constraint declaration. If a composing constraint, attribute values are reflecting the overridden attributes of the composing constraint- Returns:
- the annotation for this constraint
-
getMessageTemplate
java.lang.String getMessageTemplate()
The non-interpolated error message- Returns:
- the non-interpolated error message
- Since:
- 1.1
-
getGroups
java.util.Set<java.lang.Class<?>> getGroups()
The set of groups the constraint is applied on. If the constraint declares no group, a set with only theDefault
group is returned.- Returns:
- the groups the constraint is applied on
-
getPayload
java.util.Set<java.lang.Class<? extends Payload>> getPayload()
The set of payload the constraint hosts.- Returns:
- payload classes hosted on the constraint or an empty set if none
-
getValidationAppliesTo
ConstraintTarget getValidationAppliesTo()
- Returns:
- the
ConstraintTarget
value ornull
- Since:
- 1.1
-
getConstraintValidatorClasses
java.util.List<java.lang.Class<? extends ConstraintValidator<T,?>>> getConstraintValidatorClasses()
List of the constraint validation implementation classes.- Returns:
- list of the constraint validation implementation classes
-
getAttributes
java.util.Map<java.lang.String,java.lang.Object> getAttributes()
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.- Returns:
- a map containing the annotation attribute names as keys and the annotation attribute values as value
-
getComposingConstraints
java.util.Set<ConstraintDescriptor<?>> getComposingConstraints()
Return a set of composingConstraintDescriptor
s where each descriptor describes a composing constraint.ConstraintDescriptor
instances of composing constraints reflect overridden attribute values ingetAttributes()
andgetAnnotation()
.- Returns:
- a set of
ConstraintDescriptor
objects or an empty set in case there are no composing constraints
-
isReportAsSingleViolation
boolean isReportAsSingleViolation()
- Returns:
true
if the constraint is annotated withReportAsSingleViolation
-
-