Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.property

Class MetadataKeyPartModelProperty

java.lang.Object

org.mule.runtime.extension.api.property.MetadataKeyPartModelProperty

All Implemented Interfaces:

Serializable, org.mule.runtime.api.meta.model.ModelProperty, org.mule.runtime.api.meta.NamedObject

public final class MetadataKeyPartModelProperty
extends Object
implements org.mule.runtime.api.meta.model.ModelProperty

A ModelProperty for ParameterModel of SourceModel and OperationModel parameters that indicates that the is a part of a MetadataKey.

Since:

1.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetadataKeyPartModelProperty(int order)	Creates a new instance.
MetadataKeyPartModelProperty(int order, boolean providedByKeyResolver)	Creates a new instance.
MetadataKeyPartModelProperty(int order, boolean providedByKeyResolver, org.mule.runtime.api.meta.ExpressionSupport expressionSupport)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
org.mule.runtime.api.meta.ExpressionSupport	getExpressionSupport()	By default, metadata keys need to be static values.
String	getName()
int	getOrder()	The order of this parameter in the MetadataKey.
boolean	isProvidedByKeyResolver()
boolean	isPublic()

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataKeyPartModelProperty

public MetadataKeyPartModelProperty(int order)

Creates a new instance.

Parameters:

order - the order of the parameter in the MetadataKey;

MetadataKeyPartModelProperty

public MetadataKeyPartModelProperty(int order,
 boolean providedByKeyResolver)

Creates a new instance.

Parameters:

order - the order of the parameter in the MetadataKey;

providedByKeyResolver - whether or not this part will be provided by the keys resolver associated to the container of this part

MetadataKeyPartModelProperty

@Experimental
public MetadataKeyPartModelProperty(int order,
 boolean providedByKeyResolver,
 org.mule.runtime.api.meta.ExpressionSupport expressionSupport)

Creates a new instance.

NOTE: Experimental feature. Backwards compatibility not guaranteed.

Parameters:

order - the order of the parameter in the MetadataKey;

providedByKeyResolver - whether or not this part will be provided by the keys resolver associated to the container of this part

expressionSupport - the level of support this key part has for expressions

Since:

1.8

Method Details

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.model.ModelProperty

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

isPublic

public boolean isPublic()

Specified by:

isPublic in interface org.mule.runtime.api.meta.model.ModelProperty

getOrder

public int getOrder()

The order of this parameter in the MetadataKey.

Returns:

the order of the parameter for a composed MetadataKey, 0 if is a simple MetadataKey

isProvidedByKeyResolver

public boolean isProvidedByKeyResolver()

Returns:

whether or not this part will be provided by the keys resolver associated to the container of this part, or if this part has no predefined values and has to be provided by the user entirely.

getExpressionSupport

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

By default, metadata keys need to be static values. An error is thrown whenever an expression is provided.

This indicates whether an eventual expression is supported/required and that it will be provided unresolved as a string for the key part value.

NOTE: Experimental feature. Backwards compatibility not guaranteed.

Returns:

the level of support this key part has for expressions

Since:

1.8