org.hibernate.validator.metadata

Class ConstraintDescriptorImpl<T extends Annotation>

java.lang.Object

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

All Implemented Interfaces:

Serializable, ConstraintDescriptor<T>

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

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

Author:

Emmanuel Bernard, Hardy Ferentschik, Federico Mancini, Dag Hovland

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConstraintDescriptorImpl(T annotation, ConstraintHelper constraintHelper, Class<?> implicitGroup, ElementType type, ConstraintOrigin definedOn)
ConstraintDescriptorImpl(T annotation, ConstraintHelper constraintHelper, ElementType type, ConstraintOrigin definedOn)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
T	getAnnotation() Returns the annotation describing the constraint declaration.
Map<String,Object>	getAttributes() Returns a map containing the annotation attribute names as keys and the annotation attribute values as value.
Set<ConstraintDescriptor<?>>	getComposingConstraints() Return a set of composing ConstraintDescriptors where each descriptor describes a composing constraint.
CompositionType	getCompositionType()
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.
Set<Class<? extends Payload>>	getPayload() The set of payload the constraint hosts.
int	hashCode()
boolean	isReportAsSingleViolation()
void	setCompositionType(CompositionType compositionType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstraintDescriptorImpl

public ConstraintDescriptorImpl(T annotation,
                        ConstraintHelper constraintHelper,
                        Class<?> implicitGroup,
                        ElementType type,
                        ConstraintOrigin definedOn)

ConstraintDescriptorImpl

public ConstraintDescriptorImpl(T annotation,
                        ConstraintHelper constraintHelper,
                        ElementType type,
                        ConstraintOrigin definedOn)

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.

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.

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.

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.

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()

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

setCompositionType

public void setCompositionType(CompositionType compositionType)

Parameters:

compositionType - the compositionType to set

getCompositionType

public CompositionType getCompositionType()

Returns:

the compositionType