org.hibernate.validator.ap.internal.classchecks

Interface ClassCheck

All Known Implementing Classes:

AbstractClassCheck, AbstractMethodOverrideCheck, ParametersMethodOverrideCheck, ReturnValueMethodOverrideCheck

public interface ClassCheck

Implementations represent checks that determine whether a given class is implemented correctly.

Implementations should be derived from AbstractClassCheck in order to implement only those check methods applicable for the element kinds supported by the check.

Author:

Marko Bekhta

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ConstraintCheckIssue>	checkMethod(javax.lang.model.element.ExecutableElement element) Checks whether the given method is written correctly.
java.util.Collection<ConstraintCheckIssue>	execute(javax.lang.model.element.Element element) Run all checks on the element.

Method Detail

checkMethod

java.util.Collection<ConstraintCheckIssue> checkMethod(javax.lang.model.element.ExecutableElement element)

Checks whether the given method is written correctly.

Parameters:

element - 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

execute

java.util.Collection<ConstraintCheckIssue> execute(javax.lang.model.element.Element element)

Run all checks on the element.

Parameters:

element - the element under investigation

Returns:

a collection with errors that describe why the given element does not pass the checks. In case no errors occur (all checks completed successfully), an empty set must be returned