Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.model.function

Class ImmutableFunctionModel

java.lang.Object

org.mule.runtime.extension.api.model.AbstractImmutableModel

org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

org.mule.runtime.extension.api.model.parameter.AbstractParameterizedModel

org.mule.runtime.extension.api.model.function.ImmutableFunctionModel

All Implemented Interfaces:

org.mule.runtime.api.meta.DescribedObject, org.mule.runtime.api.meta.model.deprecated.DeprecableModel, org.mule.runtime.api.meta.model.display.HasDisplayModel, org.mule.runtime.api.meta.model.EnrichableModel, org.mule.runtime.api.meta.model.function.FunctionModel, org.mule.runtime.api.meta.model.parameter.ParameterizedModel, org.mule.runtime.api.meta.model.version.HasMinMuleVersion, org.mule.runtime.api.meta.NamedObject

public class ImmutableFunctionModel
extends AbstractParameterizedModel
implements org.mule.runtime.api.meta.model.function.FunctionModel

Immutable concrete implementation of FunctionModel

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

description, modelProperties

Constructor Summary

Constructors

Constructor	Description
ImmutableFunctionModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)	Creates a new instance with the given state
ImmutableFunctionModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)	Creates a new instance with the given state
ImmutableFunctionModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, org.mule.runtime.api.meta.MuleVersion minMuleVersion)	Creates a new instance with the given state

Method Summary

Modifier and Type	Method	Description
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
Optional<org.mule.runtime.api.meta.MuleVersion>	getMinMuleVersion()
org.mule.runtime.api.meta.model.OutputModel	getOutput()
boolean	isDeprecated()
String	toString()

Methods inherited from class org.mule.runtime.extension.api.model.parameter.AbstractParameterizedModel

getParameterGroupModels

Methods inherited from class org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

checkArgument, equals, getDisplayModel, getName, hashCode

Methods inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

copy, copy, getDescription, getModelProperties, getModelProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.model.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

Constructor Details

ImmutableFunctionModel

public ImmutableFunctionModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 org.mule.runtime.api.meta.model.OutputModel output,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Creates a new instance with the given state

Parameters:

name - the operation's name. Cannot be blank

description - the operation's descriptor

parameterGroupModels - a List with the operation's parameter group models

output - an OutputModel which represents the operation's output content

displayModel - a model which contains directive about how this operation is displayed in the UI

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if name is blank or executorFactory is null

ImmutableFunctionModel

public ImmutableFunctionModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 org.mule.runtime.api.meta.model.OutputModel output,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
 org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)

Creates a new instance with the given state

Parameters:

name - the operation's name. Cannot be blank

description - the operation's descriptor

parameterGroupModels - a List with the operation's parameter group models

output - an OutputModel which represents the operation's output content

displayModel - a model which contains directive about how this operation is displayed in the UI

modelProperties - A Set of custom properties which extend this model

deprecationModel - a DeprecationModel describing if the function is deprecated. A null value means it is not deprecated.

Throws:

IllegalArgumentException - if name is blank or executorFactory is null

ImmutableFunctionModel

public ImmutableFunctionModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 org.mule.runtime.api.meta.model.OutputModel output,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
 org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel,
 org.mule.runtime.api.meta.MuleVersion minMuleVersion)

Creates a new instance with the given state

Parameters:

name - the operation's name. Cannot be blank

description - the operation's descriptor

parameterGroupModels - a List with the operation's parameter group models

output - an OutputModel which represents the operation's output content

displayModel - a model which contains directive about how this operation is displayed in the UI

modelProperties - A Set of custom properties which extend this model

deprecationModel - a DeprecationModel describing if the function is deprecated. A null value means it is not deprecated.

minMuleVersion - the min mule version of the function

Throws:

IllegalArgumentException - if name is blank or executorFactory is null

Since:

1.5

Method Details

getOutput

public org.mule.runtime.api.meta.model.OutputModel getOutput()

Specified by:

getOutput in interface org.mule.runtime.api.meta.model.function.FunctionModel

getDeprecationModel

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

Specified by:

getDeprecationModel in interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

getMinMuleVersion

public Optional<org.mule.runtime.api.meta.MuleVersion> getMinMuleVersion()

Specified by:

getMinMuleVersion in interface org.mule.runtime.api.meta.model.version.HasMinMuleVersion

toString

public String toString()

Overrides:

toString in class AbstractParameterizedModel