org.mule.devkit.generation.javadoc

Class JavaDocAnnotationVerifier

java.lang.Object

org.mule.devkit.generation.api.AbstractBaseAnnotationVerifier

org.mule.devkit.generation.javadoc.JavaDocAnnotationVerifier

All Implemented Interfaces:

ModuleAnnotationVerifier, Verifier

Direct Known Subclasses:

SimpleJavaDocAnnotationVerifier

public class JavaDocAnnotationVerifier
extends AbstractBaseAnnotationVerifier

Constructor Summary

Constructors

Constructor and Description
JavaDocAnnotationVerifier()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMessage(Identifiable element, DevkitNotification message, Object... args)
boolean	shouldVerify(Module module) Should this verifier be executed for the given module?
protected void	validateSampleTag(Method<Type> method)
void	verify(Module module, NotificationGatherer gatherer) Verify the annotations on this module

Methods inherited from class org.mule.devkit.generation.api.AbstractBaseAnnotationVerifier

getGatherer, setGatherer

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocAnnotationVerifier

public JavaDocAnnotationVerifier()

Method Detail

shouldVerify

public boolean shouldVerify(Module module)

Description copied from interface: ModuleAnnotationVerifier

Should this verifier be executed for the given module?

Parameters:

module - The module to test

Returns:

true if it should be verified, false otherwise

verify

public void verify(Module module,
          NotificationGatherer gatherer)
            throws AnnotationVerificationException

Description copied from interface: ModuleAnnotationVerifier

Verify the annotations on this module

Parameters:

module - The module to be verified

Throws:

AnnotationVerificationException - if the verification fails

validateSampleTag

protected void validateSampleTag(Method<Type> method)
                          throws AnnotationVerificationException

Throws:

AnnotationVerificationException

addMessage

protected void addMessage(Identifiable element,
              DevkitNotification message,
              Object... args)