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

Class ImmutableParameterModel

java.lang.Object

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

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

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

All Implemented Interfaces:

org.mule.runtime.api.meta.DescribedObject, org.mule.runtime.api.meta.model.display.HasDisplayModel, org.mule.runtime.api.meta.model.display.HasLayoutModel, org.mule.runtime.api.meta.model.EnrichableModel, org.mule.runtime.api.meta.model.parameter.ParameterModel, org.mule.runtime.api.meta.NamedObject, org.mule.runtime.api.meta.Typed

public final class ImmutableParameterModel
extends AbstractNamedImmutableModel
implements org.mule.runtime.api.meta.model.parameter.ParameterModel

Immutable implementation of ParameterModel

Since:

1.0

Field Summary

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

description, modelProperties

Constructor Summary

Constructors

Constructor and Description

ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, Object defaultValue, org.mule.runtime.api.meta.model.parameter.ParameterRole role, org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.display.LayoutModel layoutModel, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Creates a new instance with the given state

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue()
org.mule.runtime.api.meta.model.ParameterDslConfiguration	getDslConfiguration()
org.mule.runtime.api.meta.ExpressionSupport	getExpressionSupport()
Optional<org.mule.runtime.api.meta.model.display.LayoutModel>	getLayoutModel()
org.mule.runtime.api.meta.model.parameter.ParameterRole	getRole()
org.mule.metadata.api.model.MetadataType	getType()
boolean	hasDynamicType()
boolean	isOverrideFromConfig()
boolean	isRequired()

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.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

ImmutableParameterModel

public ImmutableParameterModel(String name,
                               String description,
                               org.mule.metadata.api.model.MetadataType type,
                               boolean hasDynamicType,
                               boolean required,
                               boolean isConfigOverride,
                               org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                               Object defaultValue,
                               org.mule.runtime.api.meta.model.parameter.ParameterRole role,
                               org.mule.runtime.api.meta.model.ParameterDslConfiguration dslConfiguration,
                               org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                               org.mule.runtime.api.meta.model.display.LayoutModel layoutModel,
                               Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Creates a new instance with the given state

Parameters:

name - the parameter's name. Cannot be blank.

description - the parameter's description

type - the parameter's MetadataType. Cannot be null

hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time

required - whether this parameter is required or not

expressionSupport - the ExpressionSupport that applies to this ParameterModel

defaultValue - this parameter's default value

role - this parameter's purpose

dslConfiguration - a model which describes the DSL semantics for this parameter

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

layoutModel - a model which contains directives about the parameter's layout in the UI

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if required is true and defaultValue is not null at the same time

Method Detail

getType

public org.mule.metadata.api.model.MetadataType getType()

Specified by:

getType in interface org.mule.runtime.api.meta.Typed

hasDynamicType

public boolean hasDynamicType()

Specified by:

hasDynamicType in interface org.mule.runtime.api.meta.Typed

isRequired

public boolean isRequired()

Specified by:

isRequired in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

isOverrideFromConfig

public boolean isOverrideFromConfig()

Specified by:

isOverrideFromConfig in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

getExpressionSupport

public org.mule.runtime.api.meta.ExpressionSupport getExpressionSupport()

Specified by:

getExpressionSupport in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

getDslConfiguration

public org.mule.runtime.api.meta.model.ParameterDslConfiguration getDslConfiguration()

Specified by:

getDslConfiguration in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

getRole

public org.mule.runtime.api.meta.model.parameter.ParameterRole getRole()

Specified by:

getRole in interface org.mule.runtime.api.meta.model.parameter.ParameterModel

getLayoutModel

public Optional<org.mule.runtime.api.meta.model.display.LayoutModel> getLayoutModel()

Specified by:

getLayoutModel in interface org.mule.runtime.api.meta.model.display.HasLayoutModel

Specified by:

getLayoutModel in interface org.mule.runtime.api.meta.model.parameter.ParameterModel