org.hibernate.validator.ap.internal.classchecks

Class ParametersMethodOverrideCheck

java.lang.Object

org.hibernate.validator.ap.internal.classchecks.AbstractClassCheck

org.hibernate.validator.ap.internal.classchecks.AbstractMethodOverrideCheck

org.hibernate.validator.ap.internal.classchecks.ParametersMethodOverrideCheck

All Implemented Interfaces:

ClassCheck

public class ParametersMethodOverrideCheck
extends AbstractMethodOverrideCheck

Checks if the parameters of overridden and overriding methods have correctly placed annotations. Parameter constraints must not be strengthened in subtypes. The two rules implemented in this check are:

• In subtypes (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.
• If a subtype 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.

Author:

Marko Bekhta

Field Summary

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

constraintHelper

Constructor Summary

Constructors

Constructor and Description
ParametersMethodOverrideCheck(javax.lang.model.util.Elements elementUtils, javax.lang.model.util.Types typeUtils, ConstraintHelper constraintHelper)

Method Summary

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

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

checkMethod, getEnclosingTypeElementQualifiedName

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

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersMethodOverrideCheck

public ParametersMethodOverrideCheck(javax.lang.model.util.Elements elementUtils,
                                     javax.lang.model.util.Types typeUtils,
                                     ConstraintHelper constraintHelper)

Method Detail

checkMethodInternal

protected java.util.Set<ConstraintCheckIssue> checkMethodInternal(javax.lang.model.element.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(javax.lang.model.element.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