org.mule.extension.annotations

Annotation Type Parameter

@Target(value=FIELD)
@Retention(value=RUNTIME)
@Documented
public @interface Parameter

Marks a field inside a mule extension as being a parameter that the user can set. It can either be applied to a class defining a configuration, or to a class in which operations are implemented.

If applied to an operation class, then the parameter will be added to all the operations defined in that class.

The field must be a Java bean property (ie it needs to have setters and getters matching the field name).

Since:

1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	alias If provided, sets the name that the parameter will have on the introspection model.
boolean	isDynamic A parameter is considered to be dynamic if it's value can change in runtime depending on contextual circumstances.

Element Detail

isDynamic

public abstract boolean isDynamic

A parameter is considered to be dynamic if it's value can change in runtime depending on contextual circumstances. E.g.: the parameter value is a MEL expression

Returns:

whether this parameter is dynamic or not. Defaults to true

Default:

true

alias

public abstract String alias

If provided, sets the name that the parameter will have on the introspection model. Otherwise, the name of the annotated Field is used instead.

Returns:

a String. Might be blank but will never be null

Default:

""