org.hibernate.validator.internal.metadata.descriptor

Class ConstraintDescriptorImpl<T extends Annotation>

java.lang.Object

org.hibernate.validator.internal.metadata.descriptor.ConstraintDescriptorImpl<T>

All Implemented Interfaces:

Serializable, ConstraintDescriptor<T>

public class ConstraintDescriptorImpl<T extends Annotation>
extends Object
implements ConstraintDescriptor<T>, Serializable

Describes a single constraint (including it's composing constraints).

Author:

Emmanuel Bernard, Hardy Ferentschik, Federico Mancini, Dag Hovland

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstraintDescriptorImpl.ConstraintType The type of a constraint.

Constructor Summary

Constructors

Constructor and Description
ConstraintDescriptorImpl(ConstraintHelper constraintHelper, Member member, T annotation, ElementType type)
ConstraintDescriptorImpl(ConstraintHelper constraintHelper, Member member, T annotation, ElementType type, Class<?> implicitGroup, ConstraintOrigin definedOn, ConstraintDescriptorImpl.ConstraintType externalConstraintType)
ConstraintDescriptorImpl(ConstraintHelper constraintHelper, Member member, T annotation, ElementType type, ConstraintDescriptorImpl.ConstraintType constraintType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
T	getAnnotation() Returns the annotation describing the constraint declaration.
Class<T>	getAnnotationType()
Map<String,Object>	getAttributes() Returns a map containing the annotation attribute names as keys and the annotation attribute values as value.
Map<Type,Class<? extends ConstraintValidator<T,?>>>	getAvailableValidatorTypes()
Set<ConstraintDescriptorImpl<?>>	getComposingConstraintImpls()
Set<ConstraintDescriptor<?>>	getComposingConstraints() Return a set of composing ConstraintDescriptors where each descriptor describes a composing constraint.
CompositionType	getCompositionType()
ConstraintDescriptorImpl.ConstraintType	getConstraintType()
List<Class<? extends ConstraintValidator<T,?>>>	getConstraintValidatorClasses() List of the constraint validation implementation classes.
ConstraintOrigin	getDefinedOn()
ElementType	getElementType()
Set<Class<?>>	getGroups() The set of groups the constraint is applied on.
List<Class<? extends ConstraintValidator<T,?>>>	getMatchingConstraintValidatorClasses() Return all constraint validators classes (either generic or cross-parameter) which are registered for the constraint of this despriptor.
String	getMessageTemplate() The non-interpolated error message
Set<Class<? extends Payload>>	getPayload() The set of payload the constraint hosts.
ConstraintTarget	getValidationAppliesTo() The ConstraintTarget value of validationAppliesTo if the constraint hosts it or null otherwise.
int	hashCode()
boolean	isReportAsSingleViolation()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConstraintDescriptorImpl

public ConstraintDescriptorImpl(ConstraintHelper constraintHelper,
                                Member member,
                                T annotation,
                                ElementType type,
                                Class<?> implicitGroup,
                                ConstraintOrigin definedOn,
                                ConstraintDescriptorImpl.ConstraintType externalConstraintType)

ConstraintDescriptorImpl

public ConstraintDescriptorImpl(ConstraintHelper constraintHelper,
                                Member member,
                                T annotation,
                                ElementType type)

ConstraintDescriptorImpl

public ConstraintDescriptorImpl(ConstraintHelper constraintHelper,
                                Member member,
                                T annotation,
                                ElementType type,
                                ConstraintDescriptorImpl.ConstraintType constraintType)

Method Detail

getAnnotation

public T getAnnotation()

Description copied from interface: ConstraintDescriptor

Returns the annotation describing the constraint declaration. If a composing constraint, attribute values are reflecting the overridden attributes of the composing constraint

Specified by:

getAnnotation in interface ConstraintDescriptor<T extends Annotation>

Returns:

the annotation for this constraint

getAnnotationType

public Class<T> getAnnotationType()

getMessageTemplate

public String getMessageTemplate()

Description copied from interface: ConstraintDescriptor

The non-interpolated error message

Specified by:

getMessageTemplate in interface ConstraintDescriptor<T extends Annotation>

Returns:

the non-interpolated error message

getGroups

public Set<Class<?>> getGroups()

Description copied from interface: ConstraintDescriptor

The set of groups the constraint is applied on. If the constraint declares no group, a set with only the Default group is returned.

Specified by:

getGroups in interface ConstraintDescriptor<T extends Annotation>

Returns:

the groups the constraint is applied on

getPayload

public Set<Class<? extends Payload>> getPayload()

Description copied from interface: ConstraintDescriptor

The set of payload the constraint hosts.

Specified by:

getPayload in interface ConstraintDescriptor<T extends Annotation>

Returns:

payload classes hosted on the constraint or an empty set if none

getValidationAppliesTo

public ConstraintTarget getValidationAppliesTo()

Description copied from interface: ConstraintDescriptor

The ConstraintTarget value of validationAppliesTo if the constraint hosts it or null otherwise.

Specified by:

getValidationAppliesTo in interface ConstraintDescriptor<T extends Annotation>

Returns:

the ConstraintTarget value or null

getConstraintValidatorClasses

public List<Class<? extends ConstraintValidator<T,?>>> getConstraintValidatorClasses()

Description copied from interface: ConstraintDescriptor

List of the constraint validation implementation classes.

Specified by:

getConstraintValidatorClasses in interface ConstraintDescriptor<T extends Annotation>

Returns:

list of the constraint validation implementation classes

getMatchingConstraintValidatorClasses

public List<Class<? extends ConstraintValidator<T,?>>> getMatchingConstraintValidatorClasses()

Return all constraint validators classes (either generic or cross-parameter) which are registered for the constraint of this despriptor.

Returns:

The validators applying to type of this constraint.

getAvailableValidatorTypes

public Map<Type,Class<? extends ConstraintValidator<T,?>>> getAvailableValidatorTypes()

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: ConstraintDescriptor

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.

Specified by:

getAttributes in interface ConstraintDescriptor<T extends Annotation>

Returns:

a map containing the annotation attribute names as keys and the annotation attribute values as value

getComposingConstraints

public Set<ConstraintDescriptor<?>> getComposingConstraints()

Description copied from interface: ConstraintDescriptor

Return a set of composing ConstraintDescriptors where each descriptor describes a composing constraint. ConstraintDescriptor instances of composing constraints reflect overridden attribute values in ConstraintDescriptor.getAttributes() and ConstraintDescriptor.getAnnotation().

Specified by:

getComposingConstraints in interface ConstraintDescriptor<T extends Annotation>

Returns:

a set of ConstraintDescriptor objects or an empty set in case there are no composing constraints

getComposingConstraintImpls

public Set<ConstraintDescriptorImpl<?>> getComposingConstraintImpls()

isReportAsSingleViolation

public boolean isReportAsSingleViolation()

Specified by:

isReportAsSingleViolation in interface ConstraintDescriptor<T extends Annotation>

Returns:

true if the constraint is annotated with ReportAsSingleViolation

getElementType

public ElementType getElementType()

getDefinedOn

public ConstraintOrigin getDefinedOn()

getConstraintType

public ConstraintDescriptorImpl.ConstraintType getConstraintType()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getCompositionType

public CompositionType getCompositionType()

Returns:

the compositionType