org.mule.devkit.model.module
Interface Module

All Superinterfaces:

Accessible, Annotable, Documentable, Generifiable, Identifiable<TypeElement>, Type, Typeable

All Known Subinterfaces:

ManagedConnectionModule, OAuthModule, RestModule

public interface Module
extends Type

The module interface represents a type in Java that has been annotated with Module, Connector or ExpressionLanguage.

Method Summary

String	getAnnotatedSchemaLocation()
String	getConfigElementName() Retrieve the name of the config element
List<Field>	getConfigurableFields() Retrieve a list of fields that have been annotated with Configurable This method will recursively go thru all superclasses as well.
String	getCurrentSchemaLocation()
String	getDescription() Get the description of this module
List<FilterMethod>	getFilterMethods() Get a list of all methods annotated with @Filter This method will recursively go thru all superclasses as well.
String	getFriendlyName()
List<Field>	getInjectFields() Retrieve a list of fields that have been annotated with javax.inject.Inject This method will recursively go thru all superclasses as well.
ModuleKind	getKind()
Method	getLifecycleMethod(String phaseName) Retrieve the method that needs to be called during a particular lifecycle phase.
Method	getMetaDataKeyRetrieverMethod() Retrieve the method annotated with MetaDataKeyRetriever
Method	getMetaDataRetrieverMethod() Retrieve the method annotated with MetaDataRetriever
org.mule.common.MuleVersion	getMinMuleVersion() Get the minimum Mule version supported by this module
String	getModuleName()
String	getModuleSchemaVersion()
List<ProcessorMethod>	getProcessorMethods() Get a list of all methods annotated with @Processor This method will recursively go thru all superclasses as well.
Method	getQueryTranslatorMethod()
List<RestCall>	getRestCalls() Retrieve a list of all the methods inside the module that are annotated with RestCall
Field	getRestHttpClientField() Retrieve the field annotated with RestHttpClient
List<SourceMethod>	getSourceMethods() Get a list of all methods annotated with @Source This method will recursively go thru all superclasses as well.
List<TransformerMethod>	getTransformerMethods() Retrieve a list of all the methods inside the module that are annotated with Transformer
List<TransformerResolverMethod>	getTransformerResolverMethods() Retrieve a list of all the methods inside the module that are annotated with TransformerResolver
String	getVersionedSchemaLocation()
String	getXmlNamespace()
boolean	hasConfigurableWithType(Class<?> parameterType)
boolean	hasDynamicMetadata()
boolean	hasFilters() True if the module has at least one method annotated with Filter
boolean	hasMethodWithName(String methodName)
boolean	hasProcessorMethodWithParameter(Class<?> parameterType)
boolean	hasProcessors() True if the module has at least one method annotated with Processor
boolean	hasQueryTranslator()
boolean	hasRestCalls() True if the module has at least one method annotated with RestCall
boolean	hasSources() True if the module has at least one method annotated with Source
boolean	hasTransformerResolver() True if the module has at least one method annotated with TransformerResolver
boolean	hasTransformers() True if the module has at least one method annotated with Transformer
boolean	isConnector() Check if the module is annotated with Connector
boolean	isModule() Check if the module is annotated with Module
boolean	needsConfig() Return true if this module requires a config element or false if it can work without one.
Module	parentModule()
boolean	usesPooling()

Methods inherited from interface org.mule.devkit.model.Type

getClassName, getFields, getInheritedFields, getMethods, getMethodsAnnotatedWith, getPackage, getPackageName, getPathToSourceFile, getQualifiedName, getSuperClass, hasFieldAnnotatedWith, hasNoArgConstructor, hasSuperClass, inheritsFrom, inheritsFrom, isDsqlQueryObject, isInterface, isParametrized, isPrimitive

Methods inherited from interface org.mule.devkit.model.Identifiable

accept, asType, asTypeMirror, getName, isReservedIdentifier, unwrap

Methods inherited from interface org.mule.devkit.model.Annotable

getAnnotation, getAnnotationMirrors

Methods inherited from interface org.mule.devkit.model.Documentable

getJavaDocParameterSummary, getJavaDocSummary, getJavaDocTagContent, getThrowsComment, hasJavaDocTag

Methods inherited from interface org.mule.devkit.model.Accessible

isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface org.mule.devkit.model.Generifiable

getTypeArguments, getXmlDeclaredChilds, hasTypeArguments

Methods inherited from interface org.mule.devkit.model.Typeable

isArrayOrList, isBigDecimal, isBigInteger, isBoolean, isCalendar, isChar, isCollection, isComplexType, isComplexTypeWithGetterAndSetter, isDate, isDouble, isEnum, isFloat, isHttpCallback, isInteger, isLong, isMap, isNestedProcessor, isSet, isString, isURL, isXmlType

Method Detail

hasProcessorMethodWithParameter

boolean hasProcessorMethodWithParameter(Class<?> parameterType)

hasConfigurableWithType

boolean hasConfigurableWithType(Class<?> parameterType)

getSourceMethods

List<SourceMethod> getSourceMethods()

Get a list of all methods annotated with @Source

This method will recursively go thru all superclasses as well.

Returns:

A list of all methods annotated with @Source

See Also:

SourceMethod}

getProcessorMethods

List<ProcessorMethod> getProcessorMethods()

Get a list of all methods annotated with @Processor

This method will recursively go thru all superclasses as well.

Returns:

A list of all methods annotated with @Processor

See Also:

ProcessorMethod}

getFilterMethods

List<FilterMethod> getFilterMethods()

Get a list of all methods annotated with @Filter

This method will recursively go thru all superclasses as well.

Returns:

A list of all methods annotated with @Filter

See Also:

FilterMethod}

getConfigurableFields

List<Field> getConfigurableFields()

Retrieve a list of fields that have been annotated with Configurable

This method will recursively go thru all superclasses as well.

Returns:

A list of all fields annotated with Configurable

getInjectFields

List<Field> getInjectFields()

Retrieve a list of fields that have been annotated with javax.inject.Inject

This method will recursively go thru all superclasses as well.

Returns:

A list of all fields annotated with javax.inject.Inject

hasSources

boolean hasSources()

True if the module has at least one method annotated with Source

Returns:

true if the module has at least one method annotated with Source

hasProcessors

boolean hasProcessors()

True if the module has at least one method annotated with Processor

Returns:

true if the module has at least one method annotated with Processor

hasFilters

boolean hasFilters()

True if the module has at least one method annotated with Filter

Returns:

true if the module has at least one method annotated with Filter

hasTransformers

boolean hasTransformers()

True if the module has at least one method annotated with Transformer

Returns:

true if the module has at least one method annotated with Transformer

getTransformerMethods

List<TransformerMethod> getTransformerMethods()

Retrieve a list of all the methods inside the module that are annotated with Transformer

Returns:

A list with all the transformers

getTransformerResolverMethods

List<TransformerResolverMethod> getTransformerResolverMethods()

Retrieve a list of all the methods inside the module that are annotated with TransformerResolver

Returns:

A list with all the transformer resolvers

usesPooling

boolean usesPooling()

getMinMuleVersion

org.mule.common.MuleVersion getMinMuleVersion()

Get the minimum Mule version supported by this module

Returns:

The minimum Mule version in string format

getXmlNamespace

String getXmlNamespace()

getModuleName

String getModuleName()

getAnnotatedSchemaLocation

String getAnnotatedSchemaLocation()

getVersionedSchemaLocation

String getVersionedSchemaLocation()

getCurrentSchemaLocation

String getCurrentSchemaLocation()

getModuleSchemaVersion

String getModuleSchemaVersion()

getFriendlyName

String getFriendlyName()

getDescription

String getDescription()

Get the description of this module

Returns:

The description

needsConfig

boolean needsConfig()

Return true if this module requires a config element or false if it can work without one.

Returns:

True if requires a config element, false otherwise

getKind

ModuleKind getKind()

getConfigElementName

String getConfigElementName()

Retrieve the name of the config element

getLifecycleMethod

Method getLifecycleMethod(String phaseName)

Retrieve the method that needs to be called during a particular lifecycle phase.

Parameters:

phaseName - The name of the phase. Supported phases are: org.mule.api.lifecycle.Startable.PHASE_NAME, org.mule.api.lifecycle.Stoppable.PHASE_NAME, org.mule.api.lifecycle.Initialisable.PHASE_NAME, org.mule.api.lifecycle.Disposable.PHASE_NAME

Returns:

The method responsible for the requested lifecycle phase.

getRestHttpClientField

Field getRestHttpClientField()

Retrieve the field annotated with RestHttpClient

hasRestCalls

boolean hasRestCalls()

True if the module has at least one method annotated with RestCall

Returns:

true if the module has at least one method annotated with RestCall

hasTransformerResolver

boolean hasTransformerResolver()

True if the module has at least one method annotated with TransformerResolver

Returns:

true if the module has at least one method annotated with TransformerResolver

getRestCalls

List<RestCall> getRestCalls()

Retrieve a list of all the methods inside the module that are annotated with RestCall

Returns:

A list with all the REST calls

getMetaDataKeyRetrieverMethod

Method getMetaDataKeyRetrieverMethod()

Retrieve the method annotated with MetaDataKeyRetriever

Returns:

Method

getMetaDataRetrieverMethod

Method getMetaDataRetrieverMethod()

Retrieve the method annotated with MetaDataRetriever

Returns:

Method

isConnector

boolean isConnector()

Check if the module is annotated with Connector

Returns:

isModule

boolean isModule()

Check if the module is annotated with Module

Returns:

hasDynamicMetadata

boolean hasDynamicMetadata()

parentModule

Module parentModule()

hasMethodWithName

boolean hasMethodWithName(String methodName)

hasQueryTranslator

boolean hasQueryTranslator()

getQueryTranslatorMethod

Method getQueryTranslatorMethod()