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

Interface ParameterizableTypeElement

All Superinterfaces:

Type, WithAlias, WithAnnotations, WithDeclaringClass, WithElement, WithParameters

All Known Subinterfaces:

ComponentElement, ConfigurationElement, ConnectionProviderElement, ExtensionElement, OperationContainerElement, SourceElement

All Known Implementing Classes:

ExtensionTypeWrapper, ParameterizableTypeWrapper, SourceTypeWrapper

@NoImplement
public interface ParameterizableTypeElement
extends Type, WithParameters

A generic contract for any kind of component that is based in a Class and can define parameters

Since:

4.0

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the component's name
default List<ExtensionParameter>	getParameterGroups()
default List<ExtensionParameter>	getParameters()
default List<ExtensionParameter>	getParametersAnnotatedWith(Class<? extends Annotation> annotationClass)

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

asMetadataType, getAnnotatedFields, getClassInformation, getElement, getFields, getGenerics, getInterfaceGenerics, getMethod, getProperties, getSuperTypeGenerics, getTypeName, isAnyType, isAssignableFrom, isAssignableFrom, isAssignableTo, isAssignableTo, isInstantiable, isSameType, isSameType

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

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

getDeclaringClass

Method Detail

getParameters

default List<ExtensionParameter> getParameters()

Specified by:

getParameters in interface WithParameters

Returns:

A list of ExtensionParameter that represents the parameters of the component

getParameterGroups

default List<ExtensionParameter> getParameterGroups()

Specified by:

getParameterGroups in interface WithParameters

Returns:

A list of ExtensionParameter that represents the parameters of the component that are considered as parameter groups

getParametersAnnotatedWith

default List<ExtensionParameter> getParametersAnnotatedWith(Class<? extends Annotation> annotationClass)

Specified by:

getParametersAnnotatedWith in interface WithParameters

Parameters:

annotationClass - Annotation to look for parameters annotated with this class

Returns:

A list of ExtensionParameter that are annotated with the given Annotation Class

getName

String getName()

Returns the component's name

Returns:

a non blank String