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

Class JavaFunctionModelParser

java.lang.Object

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

All Implemented Interfaces:

AdditionalPropertiesModelParser, FunctionModelParser, SemanticTermsParser

public class JavaFunctionModelParser
extends Object
implements FunctionModelParser

FunctionModelParser for Java based syntax

Since:

4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.mule.runtime.api.meta.model.ModelProperty>	additionalModelProperties
protected boolean	connected
protected ExtensionElement	extensionElement
protected org.mule.runtime.extension.api.loader.ExtensionLoadingContext	loadingContext
protected OutputModelParser	outputAttributesType
protected OutputModelParser	outputType
protected boolean	supportsStreaming
protected boolean	transactional

Constructor Summary

Constructors

Constructor and Description
JavaFunctionModelParser(ExtensionElement extensionElement, FunctionElement functionElement, org.mule.runtime.extension.api.loader.ExtensionLoadingContext loadingContext)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties() Returns a list with all the model properties to be applied at the extension level which are specifically linked to the type of syntax used to define the extension.
OutputModelParser	getAttributesOutputType()
protected String	getComponentTypeName() Returns a meaningful name which describes the type of component being parsed.
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.
Set<String>	getSemanticTerms()
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
int	hashCode()
boolean	isConnected()
boolean	isIgnored()
boolean	isTransactional()
protected void	parseComponentByteStreaming(WithAnnotations element) Parses the component's byte streaming attributes and extract's the appropriate values
protected void	parseComponentConnectivity(WithParameters component) Parses the component's connectivity attributes and extract's the appropriate values
boolean	supportsStreaming()

Methods inherited from class java.lang.Object

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

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

getOutputType

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

getAdditionalModelProperties

Field Detail

outputType

protected OutputModelParser outputType

outputAttributesType

protected OutputModelParser outputAttributesType

supportsStreaming

protected boolean supportsStreaming

connected

protected boolean connected

transactional

protected boolean transactional

extensionElement

protected final ExtensionElement extensionElement

loadingContext

protected final org.mule.runtime.extension.api.loader.ExtensionLoadingContext loadingContext

additionalModelProperties

protected final List<org.mule.runtime.api.meta.model.ModelProperty> additionalModelProperties

Constructor Detail

JavaFunctionModelParser

public JavaFunctionModelParser(ExtensionElement extensionElement,
                               FunctionElement functionElement,
                               org.mule.runtime.extension.api.loader.ExtensionLoadingContext loadingContext)

Method Detail

getName

public String getName()

Specified by:

getName in interface FunctionModelParser

Returns:

The parsed component's name

getDescription

public String getDescription()

Specified by:

getDescription in interface FunctionModelParser

Returns:

the function's description

getParameterGroupModelParsers

public List<ParameterGroupModelParser> getParameterGroupModelParsers()

Description copied from interface: FunctionModelParser

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.

Specified by:

getParameterGroupModelParsers in interface FunctionModelParser

Returns:

a list with the config's ParameterGroupModelParser

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface FunctionModelParser

Returns:

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

getFunctionExecutorModelProperty

public Optional<FunctionExecutorModelProperty> getFunctionExecutorModelProperty()

Specified by:

getFunctionExecutorModelProperty in interface FunctionModelParser

Returns:

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

getSemanticTerms

public Set<String> getSemanticTerms()

Specified by:

getSemanticTerms in interface SemanticTermsParser

Returns:

a Set with the model's semantic terms

getComponentTypeName

protected String getComponentTypeName()

Returns a meaningful name which describes the type of component being parsed. Used for logging and error message generation

Returns:

the name of the parsed component type

getDeprecationModel

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

Specified by:

getDeprecationModel in interface FunctionModelParser

Returns:

the function's DeprecationModel if one was defined

getSinceMuleVersionModelProperty

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

Specified by:

getSinceMuleVersionModelProperty in interface FunctionModelParser

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

parseComponentConnectivity

protected void parseComponentConnectivity(WithParameters component)

Parses the component's connectivity attributes and extract's the appropriate values

Parameters:

component - the connected component

parseComponentByteStreaming

protected void parseComponentByteStreaming(WithAnnotations element)

Parses the component's byte streaming attributes and extract's the appropriate values

Parameters:

element - the connected component

getOutputType

public OutputModelParser getOutputType()

getAttributesOutputType

public OutputModelParser getAttributesOutputType()

supportsStreaming

public boolean supportsStreaming()

isConnected

public boolean isConnected()

isTransactional

public boolean isTransactional()

getAdditionalModelProperties

public final List<org.mule.runtime.api.meta.model.ModelProperty> getAdditionalModelProperties()

Returns a list with all the model properties to be applied at the extension level which are specifically linked to the type of syntax used to define the extension.

Specified by:

getAdditionalModelProperties in interface AdditionalPropertiesModelParser

Returns:

a list with ModelProperty instances.