org.hibernate.validator.ap.classchecks

Class ReturnValueMethodOverrideCheck

java.lang.Object

org.hibernate.validator.ap.classchecks.AbstractClassCheck

org.hibernate.validator.ap.classchecks.AbstractMethodOverrideCheck

org.hibernate.validator.ap.classchecks.ReturnValueMethodOverrideCheck

All Implemented Interfaces:

ClassCheck

public class ReturnValueMethodOverrideCheck
extends AbstractMethodOverrideCheck

Checks if the return value of overridden and overriding methods respects the inheritance rules.

Return value constraints of a method must not be weakened in subtypes. 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 subtypes (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.

Author:

Marko Bekhta, Guillaume Smet

Field Summary

Fields inherited from class org.hibernate.validator.ap.classchecks.AbstractMethodOverrideCheck

constraintHelper

Constructor Summary

Constructors

Constructor and Description
ReturnValueMethodOverrideCheck(Elements elementUtils, Types typeUtils, ConstraintHelper constraintHelper)

Method Summary

Modifier and Type	Method and Description
protected Set<ConstraintCheckIssue>	checkMethodInternal(ExecutableElement currentMethod, MethodInheritanceTree methodInheritanceTree) Performs the check of a method.
protected boolean	needToPerformAnyChecks(ExecutableElement currentMethod) There can be situations in which no checks should be performed.

Methods inherited from class org.hibernate.validator.ap.classchecks.AbstractMethodOverrideCheck

checkMethod, getEnclosingTypeElementQualifiedName

Methods inherited from class org.hibernate.validator.ap.classchecks.AbstractClassCheck

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnValueMethodOverrideCheck

public ReturnValueMethodOverrideCheck(Elements elementUtils,
                                      Types typeUtils,
                                      ConstraintHelper constraintHelper)

Method Detail

checkMethodInternal

protected Set<ConstraintCheckIssue> checkMethodInternal(ExecutableElement currentMethod,
                                                        MethodInheritanceTree methodInheritanceTree)

Description copied from class: AbstractMethodOverrideCheck

Performs the check of a method.

Specified by:

checkMethodInternal in class AbstractMethodOverrideCheck

Parameters:

currentMethod - a method to check

methodInheritanceTree - the MethodInheritanceTree of the method to check

Returns:

a set of issues if there are any, an empty set otherwise

needToPerformAnyChecks

protected boolean needToPerformAnyChecks(ExecutableElement currentMethod)

Description copied from class: AbstractMethodOverrideCheck

There can be situations in which no checks should be performed. In such cases we will not perform any work at all.

Specified by:

needToPerformAnyChecks in class AbstractMethodOverrideCheck

Parameters:

currentMethod - the method under investigation

Returns:

true if we should proceed with checks and false otherwise