org.hibernate.validator.internal.engine

Class MethodValidationConfiguration

java.lang.Object

org.hibernate.validator.internal.engine.MethodValidationConfiguration

public class MethodValidationConfiguration
extends Object

These properties modify the behavior of the Validator} with respect to the Bean Validation specification section 4.5.5. In particular:

 "Out of the box, a conforming Bean Validation provider must throw a
 ConstraintDeclarationException when discovering that any of these rules are violated.
 In addition providers may implement alternative, potentially more liberal, approaches
 for handling constrained methods in inheritance hierarchies. Possible means for activating
 such alternative behavior include provider-specific configuration properties or annotations.
 Note that client code relying on such alternative behavior is not portable between Bean
 Validation providers."
 

Author:

Chris Beckey <cbeckey@paypal.com>

Constructor Summary

Constructors

Constructor and Description
MethodValidationConfiguration()

Method Summary

Modifier and Type	Method and Description
MethodValidationConfiguration	allowMultipleCascadedValidationOnReturnValues(boolean allow) Define whether more than one constraint on a return value may be marked for cascading validation are allowed.
MethodValidationConfiguration	allowOverridingMethodAlterParameterConstraint(boolean allow) Define whether overriding methods that override constraints should throw a ConstraintDefinitionException.
MethodValidationConfiguration	allowParallelMethodsDefineParameterConstraints(boolean allow) Define whether parallel methods that define constraints should throw a ConstraintDefinitionException.
Set<MethodConfigurationRule>	getConfiguredRuleSet() Return an unmodifiable Set of MethodConfigurationRule that are to be enforced based on the configuration.
boolean	isAllowMultipleCascadedValidationOnReturnValues()
boolean	isAllowOverridingMethodAlterParameterConstraint()
boolean	isAllowParallelMethodsDefineParameterConstraints()

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodValidationConfiguration

public MethodValidationConfiguration()

Method Detail

allowOverridingMethodAlterParameterConstraint

public MethodValidationConfiguration allowOverridingMethodAlterParameterConstraint(boolean allow)

Define whether overriding methods that override constraints should throw a ConstraintDefinitionException. The default value is false, i.e. do not allow. See Section 4.5.5 of JSR-349 Specification, specifically

 "In sub types (be it sub classes/interfaces or interface implementations), no parameter constraints may
 be declared on overridden or implemented methods, nor may parameters be marked for cascaded validation.
 This would pose a strengthening of preconditions to be fulfilled by the caller."
 

Parameters:

allow - flag determining whether validation will allow overriding to alter parameter constraints.

Returns:

this following the chaining method pattern

allowMultipleCascadedValidationOnReturnValues

public MethodValidationConfiguration allowMultipleCascadedValidationOnReturnValues(boolean allow)

Define whether more than one constraint on a return value may be marked for cascading validation are allowed. The default value is false, i.e. do not allow. "One must not mark a method return value for cascaded validation more than once in a line of a class hierarchy. In other words, overriding methods on sub types (be it sub classes/interfaces or interface implementations) cannot mark the return value for cascaded validation if the return value has already been marked on the overridden method of the super type or interface."

Parameters:

allow - flag determining whether validation will allow multiple cascaded validation on return values.

Returns:

this following the chaining method pattern

allowParallelMethodsDefineParameterConstraints

public MethodValidationConfiguration allowParallelMethodsDefineParameterConstraints(boolean allow)

Define whether parallel methods that define constraints should throw a ConstraintDefinitionException. The default value is false, i.e. do not allow. See Section 4.5.5 of JSR-349 Specification, specifically "If a sub type overrides/implements a method originally defined in several parallel types of the hierarchy (e.g. two interfaces not extending each other, or a class and an interface not implemented by said class), no parameter constraints may be declared for that method at all nor parameters be marked for cascaded validation. This again is to avoid an unexpected strengthening of preconditions to be fulfilled by the caller."

Parameters:

allow - flag determining whether validation will allow parameter constraints in parallel hierarchies

Returns:

this following the chaining method pattern

isAllowOverridingMethodAlterParameterConstraint

public boolean isAllowOverridingMethodAlterParameterConstraint()

Returns:

true if more than one return value within a class hierarchy can be marked for cascaded validation, false otherwise.

isAllowMultipleCascadedValidationOnReturnValues

public boolean isAllowMultipleCascadedValidationOnReturnValues()

Returns:

true if more than one return value within a class hierarchy can be marked for cascaded validation, false otherwise.

isAllowParallelMethodsDefineParameterConstraints

public boolean isAllowParallelMethodsDefineParameterConstraints()

Returns:

true if constraints on methods in parallel class hierarchy are allowed, false otherwise.

getConfiguredRuleSet

public Set<MethodConfigurationRule> getConfiguredRuleSet()

Return an unmodifiable Set of MethodConfigurationRule that are to be enforced based on the configuration.

Returns:

a set of method configuration rules based on this configuration state