org.hibernate.validator.internal.metadata.descriptor

Class BeanDescriptorImpl<T>

java.lang.Object

org.hibernate.validator.internal.metadata.descriptor.ElementDescriptorImpl

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

All Implemented Interfaces:

BeanDescriptor, ElementDescriptor, TypeDescriptor

public class BeanDescriptorImpl<T>
extends ElementDescriptorImpl
implements BeanDescriptor, TypeDescriptor

Describes a validated bean.

Author:

Emmanuel Bernard, Hardy Ferentschik, Gunnar Morling

Nested Class Summary

Nested classes/interfaces inherited from interface javax.validation.metadata.ElementDescriptor

ElementDescriptor.ConstraintFinder

Constructor Summary

Constructors

Constructor and Description
BeanDescriptorImpl(Class<T> beanClass, Set<ConstraintDescriptorImpl<?>> classLevelConstraints, Map<String,PropertyDescriptor> properties, Map<String,MethodDescriptor> methods, boolean defaultGroupSequenceRedefined, List<Class<?>> defaultGroupSequence)

Method Summary

Methods

Modifier and Type	Method and Description
BeanDescriptor	getBeanDescriptor() Returns a descriptor for the bean related constraints of this type.
Set<MethodDescriptor>	getConstrainedMethods() Returns a set with the constrained methods of this type.
Set<PropertyDescriptor>	getConstrainedProperties() Returns a set of property descriptors having at least one constraint defined or marked as cascaded (@Valid).
MethodDescriptor	getConstraintsForMethod(String methodName, Class<?>... parameterTypes) Returns a descriptor for the specified method.
PropertyDescriptor	getConstraintsForProperty(String propertyName) Return the property descriptor for a given property.
boolean	isBeanConstrained() Returns true if the bean involves validation: a constraint is hosted on the bean itself a constraint is hosted on one of the bean properties or a bean property is marked for cascade (@Valid)
boolean	isTypeConstrained() Whether this type has any class-, property- (field or getter style) or method-level constraints or not.

Methods inherited from class org.hibernate.validator.internal.metadata.descriptor.ElementDescriptorImpl

asDescriptors, findConstraints, getConstraintDescriptors, getElementClass, hasConstraints, isCascaded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.validation.metadata.ElementDescriptor

findConstraints, getConstraintDescriptors, getElementClass, hasConstraints

Constructor Detail

BeanDescriptorImpl

public BeanDescriptorImpl(Class<T> beanClass,
                  Set<ConstraintDescriptorImpl<?>> classLevelConstraints,
                  Map<String,PropertyDescriptor> properties,
                  Map<String,MethodDescriptor> methods,
                  boolean defaultGroupSequenceRedefined,
                  List<Class<?>> defaultGroupSequence)

Method Detail

isBeanConstrained

public final boolean isBeanConstrained()

Description copied from interface: BeanDescriptor

Returns true if the bean involves validation:

• a constraint is hosted on the bean itself
• a constraint is hosted on one of the bean properties
• or a bean property is marked for cascade (@Valid)

Specified by:

isBeanConstrained in interface BeanDescriptor

Returns:

true if the bean involves validation, false otherwise.

getConstraintsForProperty

public final PropertyDescriptor getConstraintsForProperty(String propertyName)

Description copied from interface: BeanDescriptor

Return the property descriptor for a given property. Return null if the property does not exist or has no constraint nor is marked as cascaded (see BeanDescriptor.getConstrainedProperties() )

The returned object (and associated objects including ConstraintDescriptors) are immutable.

Specified by:

getConstraintsForProperty in interface BeanDescriptor

Parameters:

propertyName - property evaluated

Returns:

the property descriptor for a given property.

getConstrainedProperties

public final Set<PropertyDescriptor> getConstrainedProperties()

Description copied from interface: BeanDescriptor

Returns a set of property descriptors having at least one constraint defined or marked as cascaded (@Valid). If not property matches, an empty set is returned.

Specified by:

getConstrainedProperties in interface BeanDescriptor

isTypeConstrained

public boolean isTypeConstrained()

Description copied from interface: TypeDescriptor

Whether this type has any class-, property- (field or getter style) or method-level constraints or not. This is the case if

• a constraint is hosted at this type itself,
• a constraint is hosted on any of this type's bean properties (represented by fields or getter methods),
• any of this type's bean properties (represented by fields or getter methods) is marked for cascaded validation with the Valid annotation,
• a constraint is hosted on any of this type's method's parameters,
• any of this type's method's parameters is marked for cascaded validation with the Valid annotation,
• a constraint is hosted on the return value of any of this type's methods or
• the return value of any of this type's methods is marked for cascaded validation with the Valid annotation

Specified by:

isTypeConstrained in interface TypeDescriptor

Returns:

True, if this type has any constraints, false

getConstrainedMethods

public Set<MethodDescriptor> getConstrainedMethods()

Description copied from interface: TypeDescriptor

Returns a set with the constrained methods of this type.

Specified by:

getConstrainedMethods in interface TypeDescriptor

Returns:

A set with the constrained methods of this type, will be empty if none of this type's methods are constrained.

getConstraintsForMethod

public MethodDescriptor getConstraintsForMethod(String methodName,
                                       Class<?>... parameterTypes)

Description copied from interface: TypeDescriptor

Returns a descriptor for the specified method.

Specified by:

getConstraintsForMethod in interface TypeDescriptor

Parameters:

methodName - The name of the method to retrieve a descriptor for.

parameterTypes - The types of the parameters of the method to retrieve a descriptor for, in the order as they are defined in the method signature.

Returns:

A descriptor for the specified method or null, if no method with the given name and parameter types is declared on the type represented by this descriptor or its super types.

getBeanDescriptor

public BeanDescriptor getBeanDescriptor()

Description copied from interface: TypeDescriptor

Returns a descriptor for the bean related constraints of this type.

Specified by:

getBeanDescriptor in interface TypeDescriptor

Returns:

A bean descriptor. Will never be null, also if this type has no bean properties.