org.hibernate.validator.ap.checks.annotationparameters

Class AnnotationUserMessageCheck

java.lang.Object

org.hibernate.validator.ap.checks.AbstractConstraintCheck

org.hibernate.validator.ap.checks.annotationparameters.AnnotationParametersAbstractCheck

org.hibernate.validator.ap.checks.annotationparameters.AnnotationMessageCheck

org.hibernate.validator.ap.checks.annotationparameters.AnnotationUserMessageCheck

All Implemented Interfaces:

ConstraintCheck

public class AnnotationUserMessageCheck
extends AnnotationMessageCheck

Checks that the message provided as annotation parameter by a user is valid and gives a warning otherwise.

Author:

Marko Bekhta

Field Summary

Fields inherited from class org.hibernate.validator.ap.checks.annotationparameters.AnnotationParametersAbstractCheck

annotationApiHelper

Constructor Summary

Constructors

Constructor and Description
AnnotationUserMessageCheck(AnnotationApiHelper annotationApiHelper)

Method Summary

Modifier and Type	Method and Description
protected boolean	canCheckThisAnnotation(AnnotationMirror annotation) Verify that this check class can process such annotation.
protected Set<ConstraintCheckIssue>	doCheck(Element element, AnnotationMirror annotation) Method which actually performs the validation of the annotation parameters.

Methods inherited from class org.hibernate.validator.ap.checks.annotationparameters.AnnotationMessageCheck

checkMessage

Methods inherited from class org.hibernate.validator.ap.checks.annotationparameters.AnnotationParametersAbstractCheck

checkAnnotationType, checkField, checkMethod, checkNonAnnotationType

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationUserMessageCheck

public AnnotationUserMessageCheck(AnnotationApiHelper annotationApiHelper)

Method Detail

canCheckThisAnnotation

protected boolean canCheckThisAnnotation(AnnotationMirror annotation)

Description copied from class: AnnotationParametersAbstractCheck

Verify that this check class can process such annotation.

Overrides:

canCheckThisAnnotation in class AnnotationMessageCheck

Parameters:

annotation - annotation you want to process by this class

Returns:

true if such annotation can be processed, false otherwise.

doCheck

protected Set<ConstraintCheckIssue> doCheck(Element element,
                                            AnnotationMirror annotation)

Description copied from class: AnnotationParametersAbstractCheck

Method which actually performs the validation of the annotation parameters.

Specified by:

doCheck in class AnnotationParametersAbstractCheck

Parameters:

element - annotated element

annotation - annotation to process

Returns:

a set of ConstraintCheckIssue errors if there are any validation issues with the annotation parameters