org.mule.runtime.module.extension.api.loader.java.type

Interface ExtensionParameter

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject, WithAlias, WithAnnotations, WithElement

All Known Subinterfaces:

FieldElement, ParameterElement

All Known Implementing Classes:

FieldWrapper, ParameterWrapper

@NoImplement
public interface ExtensionParameter
extends WithAnnotations, org.mule.runtime.api.meta.NamedObject, WithAlias, WithElement

A contract for any kind of component from which an extension's parameter can be derived

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Class<?>>	IMPLICIT_ARGUMENT_TYPES

Fields inherited from interface org.mule.runtime.module.extension.api.loader.java.type.WithAlias

EMPTY

Method Summary

Modifier and Type	Method and Description
default Optional<String>	defaultValue()
Optional<? extends AnnotatedElement>	getDeclaringElement()
Optional<VariableElement>	getElement()
String	getName() Returns the component's name
String	getOwnerDescription()
Type	getType()
default boolean	isRequired()
default boolean	shouldBeAdvertised()

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

getName

Methods inherited from interface org.mule.runtime.module.extension.api.loader.java.type.WithAlias

getAlias, getDescription

Methods inherited from interface org.mule.runtime.module.extension.api.loader.java.type.WithAnnotations

getAnnotation, getValueFromAnnotation, isAnnotatedWith

Field Detail

IMPLICIT_ARGUMENT_TYPES

static final Set<Class<?>> IMPLICIT_ARGUMENT_TYPES

Method Detail

shouldBeAdvertised

default boolean shouldBeAdvertised()

Returns:

A boolean indicating whether the parameter should be advertised and added as a ParameterModel in the ExtensionModel

isRequired

default boolean isRequired()

Returns:

A boolean indicating whether the parameter is a required or not

defaultValue

default Optional<String> defaultValue()

Returns:

The Optional default value of the operation

getDeclaringElement

Optional<? extends AnnotatedElement> getDeclaringElement()

Returns:

The AnnotatedElement form which this instance was derived

getElement

Optional<VariableElement> getElement()

Specified by:

getElement in interface WithElement

Returns:

an Optional Element representing the component that implements this interface.

getType

Type getType()

Returns:

The TypeWrapper of the represented component

getName

String getName()

Returns the component's name

Returns:

a non blank String

getOwnerDescription

String getOwnerDescription()