org.hibernate.validator.ap.classchecks

Class AbstractMethodOverrideCheck

java.lang.Object

org.hibernate.validator.ap.classchecks.AbstractClassCheck

org.hibernate.validator.ap.classchecks.AbstractMethodOverrideCheck

All Implemented Interfaces:

ClassCheck

Direct Known Subclasses:

ParametersMethodOverrideCheck, ReturnValueMethodOverrideCheck

public abstract class AbstractMethodOverrideCheck
extends AbstractClassCheck

Abstract base class for ClassCheck implementations that check overridden methods.

Author:

Marko Bekhta, Guillaume Smet

Field Summary

Fields

Modifier and Type	Field and Description
protected ConstraintHelper	constraintHelper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Set<ConstraintCheckIssue>	checkMethod(ExecutableElement currentMethod) Checks whether the given method is written correctly.
protected abstract Set<ConstraintCheckIssue>	checkMethodInternal(ExecutableElement currentMethod, MethodInheritanceTree overriddenMethodsTree) Performs the check of a method.
protected String	getEnclosingTypeElementQualifiedName(ExecutableElement currentMethod) Find a String representation of qualified name (Name) of corresponding TypeElement that contains a given ExecutableElement.
protected abstract boolean	needToPerformAnyChecks(ExecutableElement currentMethod) There can be situations in which no checks should be performed.

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

Field Detail

constraintHelper

protected ConstraintHelper constraintHelper

Constructor Detail

AbstractMethodOverrideCheck

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

Method Detail

checkMethod

public Set<ConstraintCheckIssue> checkMethod(ExecutableElement currentMethod)

Description copied from interface: ClassCheck

Checks whether the given method is written correctly.

Specified by:

checkMethod in interface ClassCheck

Overrides:

checkMethod in class AbstractClassCheck

Parameters:

currentMethod - the method under investigation

Returns:

a collection with errors that describe why the given method is not correctly implemented. In case no errors occur (the method is written correctly), an empty set must be returned

checkMethodInternal

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

Performs the check of a method.

Parameters:

currentMethod - a method to check

overriddenMethodsTree - the MethodInheritanceTree of the method to check

Returns:

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

needToPerformAnyChecks

protected abstract boolean needToPerformAnyChecks(ExecutableElement currentMethod)

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

Parameters:

currentMethod - the method under investigation

Returns:

true if we should proceed with checks and false otherwise

getEnclosingTypeElementQualifiedName

protected String getEnclosingTypeElementQualifiedName(ExecutableElement currentMethod)

Find a String representation of qualified name (Name) of corresponding TypeElement that contains a given ExecutableElement.

Parameters:

currentMethod - a method

Returns:

a class/interface qualified name represented by String to which a method belongs to