net.sourceforge.jbizmo.commons.validation.util

Class ConstrainedClass

java.lang.Object

net.sourceforge.jbizmo.commons.validation.util.ConstrainedClass

public class ConstrainedClass
extends Object

A class to provide access to annotation based property constraints. ConstrainedClass supports constraints that are added to the read & write methods (getters & setters) of JavaBean properties. It does not support constraints added to either the field of the property or the method parameter of the setter.

Copyright 2010 (C) by Martin Ganserer

Version:

1.0.0

Author:

Martin Ganserer

Method Summary

Modifier and Type	Method and Description
static ConstrainedClass	getConstrainedClass(Class<?> theClass) Returns the ConstrainedClass for the given Class.
Set<String>	getConstrainedProperties()
Set<Annotation>	getConstraints(String propertyName) Returns the immutable set of constraints for a given property.
static boolean	isConstraint(Annotation annotation)

Methods inherited from class java.lang.Object

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

Method Detail

getConstrainedClass

public static ConstrainedClass getConstrainedClass(Class<?> theClass)

Returns the ConstrainedClass for the given Class.

Parameters:

theClass - the class to be wrapped

Returns:

the ConstrainedClass that wraps the given class

Throws:

IllegalArgumentException - if theClass is null

isConstraint

public static boolean isConstraint(Annotation annotation)

Parameters:

annotation - the annotation to test

Returns:

true if the given annotation is a Constraint

Throws:

IllegalArgumentException - if annotation is null

getConstraints

public Set<Annotation> getConstraints(String propertyName)
                               throws IntrospectionException

Returns the immutable set of constraints for a given property. The constraints may be annotated on the getter method and setter method and may be anywhere within the class hierarchy. The result is a set of constraints that must all be satisfied for the property to be valid.

Parameters:

propertyName - name of the property

Returns:

the set (immutable) of constraints (annotations) or an empty set if no constraints on that property

Throws:

IntrospectionException - if there are problems accessing the property

IllegalArgumentException - if propertyName is null

getConstrainedProperties

public Set<String> getConstrainedProperties()

Returns:

a set of properties that have constraints associated with them.