org.mule.runtime.module.extension.internal.loader.parser

Interface FunctionModelParser

All Superinterfaces:

AdditionalPropertiesModelParser, SemanticTermsParser

All Known Implementing Classes:

JavaFunctionModelParser

public interface FunctionModelParser
extends SemanticTermsParser, AdditionalPropertiesModelParser

Parses the syntactic definition of a FunctionModel so that the semantics reflected in it can be extracted in a uniform way, regardless of the actual syntax used by the extension developer.

Since:

4.5.0

See Also:

ExtensionModelParser

Method Summary

Modifier and Type	Method and Description
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
Optional<FunctionExecutorModelProperty>	getFunctionExecutorModelProperty()
String	getName()
OutputModelParser	getOutputType()
List<ParameterGroupModelParser>	getParameterGroupModelParsers() Returns a list with a ParameterGroupModelParser per each parameter group defined in the function.
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
boolean	isIgnored()

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.SemanticTermsParser

getSemanticTerms

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.AdditionalPropertiesModelParser

getAdditionalModelProperties

Method Detail

getName

String getName()

Returns:

the function's name

getDescription

String getDescription()

Returns:

the function's description

getOutputType

OutputModelParser getOutputType()

Returns:

an OutputModelParser describing the function's output value

getParameterGroupModelParsers

List<ParameterGroupModelParser> getParameterGroupModelParsers()

Returns a list with a ParameterGroupModelParser per each parameter group defined in the function. Each group is listed in the same order as defined in the syntax.

Returns:

a list with the config's ParameterGroupModelParser

getFunctionExecutorModelProperty

Optional<FunctionExecutorModelProperty> getFunctionExecutorModelProperty()

Returns:

the FunctionExecutorModelProperty used to create the FunctionExecutor which brings the function to life

isIgnored

boolean isIgnored()

Returns:

whether this function should be ignored and excluded from the resulting ExtensionModel

getDeprecationModel

Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel> getDeprecationModel()

Returns:

the function's DeprecationModel if one was defined

getSinceMuleVersionModelProperty

Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty> getSinceMuleVersionModelProperty()