org.mule.devkit.model
Interface Documentable

All Known Subinterfaces:

ConnectMethod, EnumType, Field<P>, FilterMethod, Identifiable<T>, ManagedConnectionModule, MetaDataModule, Method<P>, Module, OAuthCallbackParameterField, OAuthModule, Package, Parameter<P>, ProcessorMethod, RestCall, RestField, RestModule, RestParameter, SourceMethod, TransformerMethod, TransformerResolverMethod, Type, Variable<P>

public interface Documentable

This interface provides a way to interact with model elements that can have javadoc comments and tags.

Method Summary

String	getJavaDocParameterSummary(String paramName)
String	getJavaDocSummary()
String	getJavaDocTagContent(String tagName)
String	getThrowsComment(String exceptionClassName) Returns the comment for the given exception class name.
boolean	hasJavaDocTag(String tagName) Checks if the element contains the specified tag in this javadoc comments.

Method Detail

hasJavaDocTag

boolean hasJavaDocTag(String tagName)

Checks if the element contains the specified tag in this javadoc comments.

Parameters:

tagName - The name of the javadoc tag to check

Returns:

true if it contains it, false otherwise

getJavaDocSummary

String getJavaDocSummary()

getJavaDocTagContent

String getJavaDocTagContent(String tagName)

getJavaDocParameterSummary

String getJavaDocParameterSummary(String paramName)

getThrowsComment

String getThrowsComment(String exceptionClassName)

Returns the comment for the given exception class name. The class name should be exactly equal to the one that appears in the javadoc.