javax.validation.metadata

Interface BeanDescriptor

All Superinterfaces:

ElementDescriptor

All Known Implementing Classes:

BeanDescriptorImpl

public interface BeanDescriptor
extends ElementDescriptor

Describes a constrained Java Bean and the constraints associated to it.

Author:

Emmanuel Bernard

Nested Class Summary

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

ElementDescriptor.ConstraintFinder

Method Summary

Methods

Modifier and Type	Method and Description
Set<PropertyDescriptor>	getConstrainedProperties() Returns a set of property descriptors having at least one constraint defined or marked as cascaded (@Valid).
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)

Methods inherited from interface javax.validation.metadata.ElementDescriptor

findConstraints, getConstraintDescriptors, getElementClass, hasConstraints

Method Detail

isBeanConstrained

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)

Returns:

true if the bean involves validation, false otherwise.

getConstraintsForProperty

PropertyDescriptor getConstraintsForProperty(String propertyName)

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

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

Parameters:

propertyName - property evaluated

Returns:

the property descriptor for a given property.

Throws:

IllegalArgumentException - if propertyName is null

getConstrainedProperties

Set<PropertyDescriptor> getConstrainedProperties()

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.