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:

DescribedObject, HasDisplayModel, EnrichableModel, FunctionModel, ParameterizedModel, NamedObject

public class ImmutableFunctionModel
extends AbstractParameterizedModel
implements 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 and Description
ImmutableFunctionModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, OutputModel output, DisplayModel displayModel, Set<ModelProperty> modelProperties) Creates a new instance with the given state

Method Summary

Modifier and Type	Method and Description
OutputModel	getOutput() Returns a MetadataType for the value that this component sets on the output Message.getPayload() field.

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, toString

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.model.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

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

getName

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

Constructor Detail

ImmutableFunctionModel

public ImmutableFunctionModel(String name,
                              String description,
                              List<ParameterGroupModel> parameterGroupModels,
                              OutputModel output,
                              DisplayModel displayModel,
                              Set<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

Method Detail

getOutput

public OutputModel getOutput()

Description copied from interface: FunctionModel

Returns a MetadataType for the value that this component sets on the output Message.getPayload() field.

Specified by:

getOutput in interface FunctionModel

Returns:

a MetadataType representing the content type for the output messages