org.mule.runtime.api.meta.model.declaration.fluent

Class ParameterDeclarer<T extends ParameterDeclarer>

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.ParameterDeclarer<T>

All Implemented Interfaces:

HasDisplayModelDeclarer<ParameterDeclarer<T>>, HasModelProperties<ParameterDeclarer<T>>

Direct Known Subclasses:

OptionalParameterDeclarer

public class ParameterDeclarer<T extends ParameterDeclarer>
extends Object
implements HasModelProperties<ParameterDeclarer<T>>, HasDisplayModelDeclarer<ParameterDeclarer<T>>

Allows configuring a ParameterDeclaration through a fluent API

Since:

1.0

Method Summary

Modifier and Type	Method and Description
T	asConfigOverride() Marks the parameter as being a config-override.
T	describedAs(String description) Adds a description
ParameterDeclaration	getDeclaration() Gets the declaration object for this descriptor
T	ofDynamicType(org.mule.metadata.api.model.MetadataType type) Specifies the type of the ParameterModel
T	ofType(org.mule.metadata.api.model.MetadataType type) Specifies the type of the ParameterModel
T	withAllowedStereotypes(List<StereotypeModel> stereotypeModels) Sets the given List of StereotypeModel
T	withDisplayModel(DisplayModel displayModel) Sets the given displayModel
T	withDsl(ParameterDslConfiguration dslModel) Describes the language which allows configuring this parameter
T	withExpressionSupport(ExpressionSupport support)
T	withLayout(LayoutModel layoutModel) Sets the given layoutModel
ParameterDeclarer<T>	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
T	withRole(ParameterRole role) Sets the purpose of the declared parameter
T	withValueProviderModel(ValueProviderModel valueProviderModel) Sets the given valueProviderModel

Methods inherited from class java.lang.Object

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

Method Detail

ofType

public T ofType(org.mule.metadata.api.model.MetadataType type)

Specifies the type of the ParameterModel

Parameters:

type - the type of the parameter

Returns:

ofDynamicType

public T ofDynamicType(org.mule.metadata.api.model.MetadataType type)

Specifies the type of the ParameterModel

Parameters:

type - the type of the parameter

Returns:

describedAs

public T describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

this descriptor

withExpressionSupport

public T withExpressionSupport(ExpressionSupport support)

withDsl

public T withDsl(ParameterDslConfiguration dslModel)

Describes the language which allows configuring this parameter

Parameters:

dslModel - an ParameterDslConfiguration

Returns:

this declarer

withLayout

public T withLayout(LayoutModel layoutModel)

Sets the given layoutModel

Parameters:

layoutModel - a LayoutModel

Returns:

this declarer

withRole

public T withRole(ParameterRole role)

Sets the purpose of the declared parameter

Parameters:

role - a ParameterRole

Returns:

this declarer

asConfigOverride

public T asConfigOverride()

Marks the parameter as being a config-override.

Returns:

this declarer

withModelProperty

public ParameterDeclarer<T> withModelProperty(ModelProperty modelProperty)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<ParameterDeclarer<T extends ParameterDeclarer>>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer

withDisplayModel

public T withDisplayModel(DisplayModel displayModel)

Sets the given displayModel

Specified by:

withDisplayModel in interface HasDisplayModelDeclarer<ParameterDeclarer<T extends ParameterDeclarer>>

Parameters:

displayModel - a DisplayModel

Returns:

this declarer

withValueProviderModel

public T withValueProviderModel(ValueProviderModel valueProviderModel)

Sets the given valueProviderModel

Parameters:

valueProviderModel - a ValueProviderModel

Returns:

this declarer

withAllowedStereotypes

public T withAllowedStereotypes(List<StereotypeModel> stereotypeModels)

Sets the given List of StereotypeModel

Parameters:

stereotypeModels - a List of StereotypeModel

Returns:

this declarer

getDeclaration

public ParameterDeclaration getDeclaration()

Gets the declaration object for this descriptor

Returns:

a ParameterDeclaration