org.mule.runtime.module.extension.internal.util

Class IntrospectionUtils

java.lang.Object

org.mule.runtime.module.extension.internal.util.IntrospectionUtils

public final class IntrospectionUtils
extends Object

Set of utility operations to get insights about objects and their components

Since:

3.7.0

Method Summary

Modifier and Type	Method and Description
static boolean	assignableFromAny(Class<?> type, Collection<Class<?>> matchingTypes) Determines if the given type is assignable from any of the matchingTypes
static void	checkInstantiable(Class<?> declaringClass, boolean requireDefaultConstructor, ReflectionCache reflectionCache)
static void	checkInstantiable(Class<?> declaringClass, ReflectionCache reflectionCache)
static Set<Class<?>>	collectRelativeClasses(org.mule.metadata.api.model.MetadataType type, ClassLoader extensionClassLoader) Given a MetadataType it adds all the Class that are related from that type.
static Set<String>	collectRelativeClassesAsString(org.mule.metadata.api.model.MetadataType type) Given a MetadataType it adds all the Class that are related from that type.
static Optional<Field>	fetchConfigFieldFromSourceObject(Object object) Given a Source object, fetches the Config field from the object if any.
static Optional<Field>	fetchConnectionFieldFromSourceObject(Object object) Given a Source object, fetches the Connection field from the object if any.
static List<Class<?>>	findGenericsInSuperHierarchy(Class<?> type)
static String	getAlias(Field field) Returns the Alias or Alias name of the given field.
static Optional<AnnotatedElement>	getAnnotatedElement(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<?> declaration)
static List<Field>	getAnnotatedFields(Class<?> clazz, Class<? extends Annotation>... annotationTypes)
static Stream<Field>	getAnnotatedFieldsStream(Class<?> clazz, Class<? extends Annotation>... annotationTypes) Returns a Stream with the fields annotated with any of the given annotationTypes
static <T extends Annotation> T	getAnnotation(Class<?> annotatedClass, Class<T> annotationClass) Looks for the annotation in the given class.
static Collection<Method>	getApiMethods(Class<?> declaringClass)
static Collection<ExecutableElement>	getApiMethods(TypeElement typeElement, ProcessingEnvironment processingEnvironment)
static Optional<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel>	getConnectionProviderModel(Class<? extends org.mule.runtime.api.connection.ConnectionProvider> connectionProvider, List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> allConnectionProviders) Resolves the correspondent ConnectionProviderModel for a given ConnectionProvider instance.
static String	getContainerName(AnnotatedElement container)
static Optional<FieldSetter>	getDefaultEncodingFieldSetter(Object target, ReflectionCache reflectionCache) Returns a FieldSetter for a field in the target annotated DefaultEncoding (if present)
static Collection<Field>	getExposedFields(Class<?> extensionType, ReflectionCache reflectionCache)
static Optional<org.mule.runtime.api.meta.ExpressionSupport>	getExpressionSupport(WithAnnotations annotatedElement, String elementType, String elementName)
static Optional<Field>	getField(Class<?> clazz, org.mule.runtime.api.meta.model.declaration.fluent.ParameterDeclaration parameterDeclaration, ReflectionCache reflectionCache)
static Optional<Field>	getField(Class<?> clazz, org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel, ReflectionCache reflectionCache)
static Optional<Field>	getField(Class<?> clazz, String name, ReflectionCache reflectionCache)
static Optional<Field>	getFieldByNameOrAlias(Class<?> clazz, String nameOrAlias, ReflectionCache reflectionCache)
static org.mule.metadata.api.model.MetadataType	getFieldMetadataType(Field field, org.mule.metadata.api.ClassTypeLoader typeLoader) Returns a MetadataType describing the given Field's type
static List<Field>	getFields(Class<?> clazz)
static List<VariableElement>	getFields(TypeElement typeElement, ProcessingEnvironment processingEnvironment)
static List<Field>	getFieldsOfType(Class<?> introspectedType, Class fieldType)
static Set<Field>	getFieldsWithGetters(Class<?> extensionType, ReflectionCache reflectionCache)
static List<FieldElement>	getFieldsWithGetters(Type extensionType)
static Object	getFieldValue(Object object, String fieldName, ReflectionCache reflectionCache) Resolves and returns the field value of an object instance
static Map<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel,Set<org.mule.runtime.api.meta.model.parameter.ParameterModel>>	getFilteredParameters(org.mule.runtime.api.meta.model.ComponentModel componentModel, Predicate<org.mule.runtime.api.meta.model.parameter.ParameterModel> filter) Returns, for each parameter group defined on the component model, all the parameters matching with the given filter
static List<org.mule.metadata.api.model.MetadataType>	getGenerics(Type type, org.mule.metadata.api.ClassTypeLoader typeLoader)
static String	getGroupModelContainerName(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel groupModel)
static String	getImplementingName(org.mule.runtime.api.meta.model.declaration.fluent.ParameterDeclaration parameterDeclaration) Resolves the original name of a parameter before it was modified due to the usage of an Alias.
static String	getImplementingName(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel) Resolves the original name of a parameter before it was modified due to the usage of an Alias.
static List<Type>	getInterfaceGenerics(Type type, Class<?> implementedInterface)
static Optional<Field>	getMemberField(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel)
static String	getMemberName(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel, String defaultName)
static <T extends org.mule.runtime.api.meta.model.EnrichableModel & org.mule.runtime.api.meta.NamedObject> String	getMemberName(T enrichableNamedModel)
static org.mule.metadata.api.model.MetadataType	getMetadataType(Class<?> type, org.mule.metadata.api.ClassTypeLoader typeLoader) Returns a MetadataType representing the given Class type.
static org.mule.metadata.api.model.MetadataType	getMetadataType(Type type)
static org.mule.metadata.api.model.MetadataType[]	getMethodArgumentTypes(Method method, org.mule.metadata.api.ClassTypeLoader typeLoader) Returns an array of MetadataType representing each of the given Method's argument types.
static org.mule.metadata.api.model.MetadataType	getMethodReturnAttributesType(MethodElement method) Returns a MetadataType representing the Result.getAttributes() that will be set after executing the given method.
static org.mule.metadata.api.model.MetadataType	getMethodReturnType(MethodElement method)
static Collection<Method>	getMethodsAnnotatedWith(Class<?> declaringClass, Class<? extends Annotation> annotationType) Returns all the methods in the declaringClass which are annotated with annotationType, including those declared in super classes.
static Collection<Method>	getMethodsAnnotatedWith(Class<?> declaringClass, Class<? extends Annotation> annotationType, boolean superClasses) Returns all the methods in the declaringClass which are annotated with annotationType
static Stream<ExecutableElement>	getMethodsStream(TypeElement typeElement, boolean superClasses, ProcessingEnvironment processingEnvironment)
static Optional<Class<?>>	getNullSafeDefaultImplementedType(Field field)
static org.mule.runtime.api.util.Pair<org.springframework.core.ResolvableType,org.springframework.core.ResolvableType>	getPagingProviderTypes(org.springframework.core.ResolvableType pagingProvider) Introspects a PagingProvider type and returns their generics.
static org.mule.runtime.api.util.Pair<Type,Type>	getPagingProviderTypes(Type type) Introspects a PagingProvider type and returns their generics.
static Set<Class<?>>	getParameterClasses(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, ClassLoader extensionClassLoader) Traverses through all the ParameterModels of the extensionModel and returns the classes that are modeled by each parameter's Typed.getType().
static <T> T	getParameterOrDefault(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<? extends org.mule.runtime.api.meta.model.ComponentModel> ctx, org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel, org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel, T defaultValue, ReflectionCache reflectionCache) Returns the value associated to a parameter with model parameterModel on the group parameterGroupModel or defaultValue if such parameter is not present
static Object	getParameterValue(Object object, org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel, ReflectionCache reflectionCache) Returns the value for the given parameter of an object instance
static List<PropertyDescriptor>	getPropertyDescriptors(Class<?> extensionType)
static Optional<FieldSetter>	getRefNameFieldSetter(Object target, ReflectionCache reflectionCache) Returns FieldSetter for a field in the target annotated RefName or RefName if present.
static org.mule.metadata.api.model.MetadataType	getReturnType(Type returnType)
static Map<String,String>	getShowInDslParameters(org.mule.runtime.api.meta.model.parameter.ParameterizedModel parameterizedModel) Given a ParameterizedModel iterates over all the parameter groups show in dsl and returns a mapping of parameter name and parameter group name.
static String	getSourceName(Class<?> sourceType)
static org.mule.metadata.api.model.MetadataType	getSourceReturnType(Type returnType) Returns the MetadataType for a source's output.
static Set<Class<?>>	getSubtypeClasses(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, ClassLoader extensionClassLoader) Traverses through all the object types of the extension model's SubTypesModel and returns the classes that are used behind of each type.
static List<Type>	getSuperClassGenerics(Type currentType, Class<?> superClass)
static List<TypeMirror>	getSuperClassGenerics(TypeElement type, Class superClass, ProcessingEnvironment processingEnvironment)
static void	injectComponentLocation(Object target, org.mule.runtime.api.component.location.ComponentLocation componentLocation) Introspects the target object for a field of type ComponentLocation.
static void	injectDefaultEncoding(org.mule.runtime.api.meta.model.EnrichableModel model, Object target, String encoding) Sets the encoding value into the field of the target annotated DefaultEncoding if the model contains the DeclaringMemberModelProperty property and the value is not null.
static void	injectFields(org.mule.runtime.api.meta.model.EnrichableModel model, Object target, String configName, String encoding, org.mule.runtime.api.meta.MuleVersion muleVersion) Sets the configName, encoding and MuleVersion into the fields of the target annotated with RefName, DefaultEncoding and RuntimeVersion respectively if present and the model contains the DeclaringMemberModelProperty.
static void	injectFields(Object target, String configName, String encoding, org.mule.runtime.api.meta.MuleVersion muleVersion, ReflectionCache reflectionCache) Sets the configName, encoding and MuleVersion into the fields of the target annotated with RefName, DefaultEncoding and RuntimeVersion respectively if present.
static void	injectRefName(Object target, String configName, ReflectionCache reflectionCache) Introspects the target object for a field annotated with RefName or RefName.
static void	injectRuntimeVersion(org.mule.runtime.api.meta.model.EnrichableModel model, Object target, org.mule.runtime.api.meta.MuleVersion muleVersion) Sets the MuleVersion into the field of the target annotated RuntimeVersion if the model contains the DeclaringMemberModelProperty property and the value is not null.
static boolean	isASTMode(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration model) Based on a BaseDeclaration, determines if this one has been created using the Java AST.
static boolean	isASTMode(org.mule.runtime.api.meta.model.ExtensionModel model) Based on a ExtensionModel, determines if this one has been created using the Java AST.
static boolean	isConfigOverride(Field field)
static boolean	isIgnored(WithAnnotations element, org.mule.runtime.extension.api.loader.ExtensionLoadingContext context) Determines if the referenced element should be ignored
static boolean	isInstantiable(Class<?> declaringClass, boolean requireDefaultConstructor, ReflectionCache reflectionCache)
static boolean	isInstantiable(Class<?> declaringClass, ReflectionCache reflectionCache)
static boolean	isInstantiable(org.mule.metadata.api.model.MetadataType type, ReflectionCache reflectionCache)
static boolean	isLifecycle(Class<?> type) Determines if the given type implements any of the lifecycle annotations
static boolean	isLifecycle(Type type) Determines if the given type implements any of the lifecycle annotations
static boolean	isLiteral(org.mule.metadata.api.model.MetadataType metadataType)
static boolean	isMultiLevelMetadataKeyId(Set<Class<? extends Annotation>> annotations, org.mule.metadata.api.model.MetadataType parameterType) Given a Set of Annotation classes and a MetadataType that describes a component parameter, indicates if the parameter is considered as a multilevel MetadataKeyId
static boolean	isParameterContainer(Set<Class<? extends Annotation>> annotations, org.mule.metadata.api.model.MetadataType parameterType) Given a Set of annotation classes and a MetadataType of a component parameter, indicates if the parameter is a parameter container.
static boolean	isParameterResolver(org.mule.metadata.api.model.MetadataType metadataType)
static boolean	isRequired(AccessibleObject object)
static boolean	isRequired(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel, boolean forceOptional)
static boolean	isTargetParameter(Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)
static boolean	isTypedValue(org.mule.metadata.api.model.MetadataType metadataType)
static boolean	isVoid(org.mule.runtime.api.meta.model.ComponentModel componentModel)
static boolean	isVoid(Method method)
static boolean	isVoid(MethodElement methodElement)
static void	setValueIntoField(Object target, Object value, Field field) Sets the given value into the target field
static void	setValueIntoField(Object target, Object value, String fieldName, ReflectionCache reflectionCache) Sets the given value into the target, if it contains a field named fieldName.
static org.mule.runtime.api.metadata.DataType	toDataType(org.mule.metadata.api.model.MetadataType metadataType) Transforms a MetadataType and generates the correspondent DataType

Methods inherited from class java.lang.Object

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

Method Detail

getMetadataType

public static org.mule.metadata.api.model.MetadataType getMetadataType(Class<?> type,
                                                                       org.mule.metadata.api.ClassTypeLoader typeLoader)

Returns a MetadataType representing the given Class type.

Parameters:

type - the Class being introspected

typeLoader - a ClassTypeLoader used to create the MetadataType

Returns:

a MetadataType

getMetadataType

public static org.mule.metadata.api.model.MetadataType getMetadataType(Type type)

toDataType

public static org.mule.runtime.api.metadata.DataType toDataType(org.mule.metadata.api.model.MetadataType metadataType)

Transforms a MetadataType and generates the correspondent DataType

Parameters:

metadataType - to introspect a create a DataType from it.

Returns:

a DataType based on the given MetadataType

isASTMode

public static boolean isASTMode(org.mule.runtime.api.meta.model.ExtensionModel model)

Based on a ExtensionModel, determines if this one has been created using the Java AST.

Parameters:

model - Extension model to introspect

Returns:

a boolean indicating whether the ExtensionModel was created using the Java AST or using compiled classes

isASTMode

public static boolean isASTMode(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration model)

Based on a BaseDeclaration, determines if this one has been created using the Java AST.

Parameters:

model - Base Declaration to introspect

Returns:

a boolean indicating whether the BaseDeclaration was created using the Java AST or using compiled classes

getMethodReturnType

public static org.mule.metadata.api.model.MetadataType getMethodReturnType(MethodElement method)

getSourceReturnType

public static org.mule.metadata.api.model.MetadataType getSourceReturnType(Type returnType)

Returns the MetadataType for a source's output.

If the type is a collection of Result instances, then it will return an ArrayType which inner value represent a Message which payload and attributes matches the types of the Result generics.

Parameters:

returnType - the source output type

Returns:

a MetadataType

getReturnType

public static org.mule.metadata.api.model.MetadataType getReturnType(Type returnType)

getMethodReturnAttributesType

public static org.mule.metadata.api.model.MetadataType getMethodReturnAttributesType(MethodElement method)

Returns a MetadataType representing the Result.getAttributes() that will be set after executing the given method.

If the method returns a Result, then it returns the type of the Attributes generic. In any other case (including raw uses of Result) it will return a VoidType

If the method returns a collection or a PagingProvider of Result, then this will return VoidType since the messages in the main output already contain an attributes for each item.

Parameters:

method - the Method being introspected

Returns:

a MetadataType

Throws:

IllegalArgumentException - is method is null

getGenerics

public static List<org.mule.metadata.api.model.MetadataType> getGenerics(Type type,
                                                                         org.mule.metadata.api.ClassTypeLoader typeLoader)

isLifecycle

public static boolean isLifecycle(Class<?> type)

Determines if the given type implements any of the lifecycle annotations

Parameters:

type - the class to evaluate

Returns:

whether it implements lifecycle or not

isLifecycle

public static boolean isLifecycle(Type type)

Determines if the given type implements any of the lifecycle annotations

Parameters:

type - the class to evaluate

Returns:

whether it implements lifecycle or not

getMethodArgumentTypes

public static org.mule.metadata.api.model.MetadataType[] getMethodArgumentTypes(Method method,
                                                                                org.mule.metadata.api.ClassTypeLoader typeLoader)

Returns an array of MetadataType representing each of the given Method's argument types.

Parameters:

method - a not null Method

typeLoader - a ClassTypeLoader to be used to create the returned MetadataTypes

Returns:

an array of MetadataType matching the method's arguments. If the method doesn't take any, then the array will be empty

Throws:

IllegalArgumentException - is method is null

getFieldMetadataType

public static org.mule.metadata.api.model.MetadataType getFieldMetadataType(Field field,
                                                                            org.mule.metadata.api.ClassTypeLoader typeLoader)

Returns a MetadataType describing the given Field's type

Parameters:

field - a not null Field

typeLoader - a ClassTypeLoader used to create the MetadataType

Returns:

a MetadataType matching the field's type

Throws:

IllegalArgumentException - if field is null

getFieldByNameOrAlias

public static Optional<Field> getFieldByNameOrAlias(Class<?> clazz,
                                                    String nameOrAlias,
                                                    ReflectionCache reflectionCache)

getField

public static Optional<Field> getField(Class<?> clazz,
                                       org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel,
                                       ReflectionCache reflectionCache)

getField

public static Optional<Field> getField(Class<?> clazz,
                                       org.mule.runtime.api.meta.model.declaration.fluent.ParameterDeclaration parameterDeclaration,
                                       ReflectionCache reflectionCache)

getField

public static Optional<Field> getField(Class<?> clazz,
                                       String name,
                                       ReflectionCache reflectionCache)

getFieldValue

public static Object getFieldValue(Object object,
                                   String fieldName,
                                   ReflectionCache reflectionCache)
                            throws IllegalAccessException,
                                   NoSuchFieldException

Resolves and returns the field value of an object instance

Parameters:

object - The object where grab the field value

fieldName - The name of the field to obtain the value

reflectionCache - the cache for expensive reflection lookups

Returns:

The value of the field with the given fieldName and object instance

Throws:

IllegalAccessException - if is unavailable to access to the field

NoSuchFieldException - if the field doesn't exist in the given object instance

getMemberName

public static <T extends org.mule.runtime.api.meta.model.EnrichableModel & org.mule.runtime.api.meta.NamedObject> String getMemberName(T enrichableNamedModel)

getMemberName

public static String getMemberName(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel,
                                   String defaultName)

getMemberField

public static Optional<Field> getMemberField(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel)

getInterfaceGenerics

public static List<Type> getInterfaceGenerics(Type type,
                                              Class<?> implementedInterface)

findGenericsInSuperHierarchy

public static List<Class<?>> findGenericsInSuperHierarchy(Class<?> type)

getSuperClassGenerics

public static List<TypeMirror> getSuperClassGenerics(TypeElement type,
                                                     Class superClass,
                                                     ProcessingEnvironment processingEnvironment)

getSuperClassGenerics

public static List<Type> getSuperClassGenerics(Type currentType,
                                               Class<?> superClass)

checkInstantiable

public static void checkInstantiable(Class<?> declaringClass,
                                     ReflectionCache reflectionCache)

checkInstantiable

public static void checkInstantiable(Class<?> declaringClass,
                                     boolean requireDefaultConstructor,
                                     ReflectionCache reflectionCache)

isInstantiable

public static boolean isInstantiable(org.mule.metadata.api.model.MetadataType type,
                                     ReflectionCache reflectionCache)

isInstantiable

public static boolean isInstantiable(Class<?> declaringClass,
                                     ReflectionCache reflectionCache)

isInstantiable

public static boolean isInstantiable(Class<?> declaringClass,
                                     boolean requireDefaultConstructor,
                                     ReflectionCache reflectionCache)

assignableFromAny

public static boolean assignableFromAny(Class<?> type,
                                        Collection<Class<?>> matchingTypes)

Determines if the given type is assignable from any of the matchingTypes

Parameters:

type - a Class

matchingTypes - a collection of classes to test against

Returns:

whether the type is assignable or not

isRequired

public static boolean isRequired(AccessibleObject object)

isRequired

public static boolean isRequired(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel,
                                 boolean forceOptional)

isVoid

public static boolean isVoid(Method method)

isVoid

public static boolean isVoid(org.mule.runtime.api.meta.model.ComponentModel componentModel)

isVoid

public static boolean isVoid(MethodElement methodElement)

getApiMethods

public static Collection<Method> getApiMethods(Class<?> declaringClass)

getApiMethods

public static Collection<ExecutableElement> getApiMethods(TypeElement typeElement,
                                                          ProcessingEnvironment processingEnvironment)

isIgnored

public static boolean isIgnored(WithAnnotations element,
                                org.mule.runtime.extension.api.loader.ExtensionLoadingContext context)

Determines if the referenced element should be ignored

Parameters:

element - a WithAnnotations declaration

context - the introspection ExtensionLoadingContext

Returns:

whether the source is ignored or not

Since:

4.4.0

getMethodsAnnotatedWith

public static Collection<Method> getMethodsAnnotatedWith(Class<?> declaringClass,
                                                         Class<? extends Annotation> annotationType)

Returns all the methods in the declaringClass which are annotated with annotationType, including those declared in super classes.

Parameters:

declaringClass - the type to introspect

annotationType - the annotation you're looking for

Returns:

a Collection of Methods

getMethodsAnnotatedWith

public static Collection<Method> getMethodsAnnotatedWith(Class<?> declaringClass,
                                                         Class<? extends Annotation> annotationType,
                                                         boolean superClasses)

Returns all the methods in the declaringClass which are annotated with annotationType

Parameters:

declaringClass - the type to introspect

annotationType - the annotation you're looking for

superClasses - whether to consider supper classes or not

Returns:

a Collection of Methods

getMethodsStream

public static Stream<ExecutableElement> getMethodsStream(TypeElement typeElement,
                                                         boolean superClasses,
                                                         ProcessingEnvironment processingEnvironment)

getAnnotatedFieldsStream

public static Stream<Field> getAnnotatedFieldsStream(Class<?> clazz,
                                                     Class<? extends Annotation>... annotationTypes)

Returns a Stream with the fields annotated with any of the given annotationTypes

Parameters:

clazz - The class to instrospect

annotationTypes - the annotation types

Returns:

a Stream

Since:

4.5.0

getAnnotatedFields

public static List<Field> getAnnotatedFields(Class<?> clazz,
                                             Class<? extends Annotation>... annotationTypes)

getFields

public static List<Field> getFields(Class<?> clazz)

getFields

public static List<VariableElement> getFields(TypeElement typeElement,
                                              ProcessingEnvironment processingEnvironment)

getFieldsOfType

public static List<Field> getFieldsOfType(Class<?> introspectedType,
                                          Class fieldType)

getAlias

public static String getAlias(Field field)

Returns the Alias or Alias name of the given field.

If the element doesn't have an alias, then the default name is returned

Parameters:

field - the introspected field

Returns:

an alias name

isConfigOverride

public static boolean isConfigOverride(Field field)

Parameters:

field - a field

Returns:

whether the given field is a config override

getNullSafeDefaultImplementedType

public static Optional<Class<?>> getNullSafeDefaultImplementedType(Field field)

Parameters:

field - a field

Returns:

NullSafe.defaultImplementingType() Optional or NullSafe.defaultImplementingType() Optional in case the given field is annotated.

getExposedFields

public static Collection<Field> getExposedFields(Class<?> extensionType,
                                                 ReflectionCache reflectionCache)

getFieldsWithGetters

public static Set<Field> getFieldsWithGetters(Class<?> extensionType,
                                              ReflectionCache reflectionCache)

getFieldsWithGetters

public static List<FieldElement> getFieldsWithGetters(Type extensionType)

getPropertyDescriptors

public static List<PropertyDescriptor> getPropertyDescriptors(Class<?> extensionType)

getExpressionSupport

public static Optional<org.mule.runtime.api.meta.ExpressionSupport> getExpressionSupport(WithAnnotations annotatedElement,
                                                                                         String elementType,
                                                                                         String elementName)

getSourceName

public static String getSourceName(Class<?> sourceType)

getAnnotation

public static <T extends Annotation> T getAnnotation(Class<?> annotatedClass,
                                                     Class<T> annotationClass)

Looks for the annotation in the given class. If the annotation is not found, it keeps looking recursively for it in the superClass until it finds it or there is no superClass to analyze.

getParameterClasses

public static Set<Class<?>> getParameterClasses(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                                ClassLoader extensionClassLoader)

Traverses through all the ParameterModels of the extensionModel and returns the classes that are modeled by each parameter's Typed.getType().

This includes every single ParameterModel in the model, including configs, providers, operations, etc.

Parameters:

extensionModel - a ExtensionModel

Returns:

a non null Set

getSubtypeClasses

public static Set<Class<?>> getSubtypeClasses(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                              ClassLoader extensionClassLoader)

Traverses through all the object types of the extension model's SubTypesModel and returns the classes that are used behind of each type.

Parameters:

extensionModel - a ExtensionModel

Returns:

a non null Set

Since:

4.1

collectRelativeClasses

public static Set<Class<?>> collectRelativeClasses(org.mule.metadata.api.model.MetadataType type,
                                                   ClassLoader extensionClassLoader)

Given a MetadataType it adds all the Class that are related from that type. This includes generics of an ArrayType, open restriction of an ObjectType as well as its fields.

Parameters:

type - MetadataType to inspect

extensionClassLoader - extension class loader

Returns:

Set> with the classes reachable from the type

collectRelativeClassesAsString

public static Set<String> collectRelativeClassesAsString(org.mule.metadata.api.model.MetadataType type)

Given a MetadataType it adds all the Class that are related from that type. This includes generics of an ArrayType, open restriction of an ObjectType as well as its fields.

Parameters:

type - MetadataType to inspect

Returns:

Set> with the classes reachable from the type

isMultiLevelMetadataKeyId

public static boolean isMultiLevelMetadataKeyId(Set<Class<? extends Annotation>> annotations,
                                                org.mule.metadata.api.model.MetadataType parameterType)

Given a Set of Annotation classes and a MetadataType that describes a component parameter, indicates if the parameter is considered as a multilevel MetadataKeyId

Parameters:

annotations - of the parameter

parameterType - of the parameter

Returns:

a boolean indicating if the Parameter is considered as a multilevel MetadataKeyId

isParameterContainer

public static boolean isParameterContainer(Set<Class<? extends Annotation>> annotations,
                                           org.mule.metadata.api.model.MetadataType parameterType)

Given a Set of annotation classes and a MetadataType of a component parameter, indicates if the parameter is a parameter container.

To be a parameter container means that the parameter is a ParameterGroup or a multilevel MetadataKeyId.

Parameters:

annotations - of the component parameter

parameterType - of the component parameter

Returns:

a boolean indicating if the parameter is considered as a parameter container

getAnnotatedElement

public static Optional<AnnotatedElement> getAnnotatedElement(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<?> declaration)

getContainerName

public static String getContainerName(AnnotatedElement container)

getGroupModelContainerName

public static String getGroupModelContainerName(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel groupModel)

getImplementingName

public static String getImplementingName(org.mule.runtime.api.meta.model.declaration.fluent.ParameterDeclaration parameterDeclaration)

Resolves the original name of a parameter before it was modified due to the usage of an Alias.

Parameters:

parameterDeclaration - parameter from which look for their original name

Returns:

the original name

getImplementingName

public static String getImplementingName(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel)

Resolves the original name of a parameter before it was modified due to the usage of an Alias.

Parameters:

parameterModel - parameter from which look for their original name

Returns:

the original name

isParameterResolver

public static boolean isParameterResolver(org.mule.metadata.api.model.MetadataType metadataType)

isTargetParameter

public static boolean isTargetParameter(Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

isLiteral

public static boolean isLiteral(org.mule.metadata.api.model.MetadataType metadataType)

isTypedValue

public static boolean isTypedValue(org.mule.metadata.api.model.MetadataType metadataType)

getConnectionProviderModel

public static Optional<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> getConnectionProviderModel(Class<? extends org.mule.runtime.api.connection.ConnectionProvider> connectionProvider,
                                                                                                                      List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> allConnectionProviders)

Resolves the correspondent ConnectionProviderModel for a given ConnectionProvider instance.

Parameters:

connectionProvider - connection provider class

allConnectionProviders - list of available ConnectionProviderModel

Returns:

an Optional value of the ConnectionProviderModel

injectFields

public static void injectFields(org.mule.runtime.api.meta.model.EnrichableModel model,
                                Object target,
                                String configName,
                                String encoding,
                                org.mule.runtime.api.meta.MuleVersion muleVersion)

Sets the configName, encoding and MuleVersion into the fields of the target annotated with RefName, DefaultEncoding and RuntimeVersion respectively if present and the model contains the DeclaringMemberModelProperty.

Parameters:

model - enriched with InjectedFieldModelProperty

target - object in which the fields are going to be set

configName - to be injected into the String field annotated with RefName

encoding - to be injected into the String field annotated with DefaultEncoding

muleVersion - to be injected into the MuleVersion field annotated with RuntimeVersion

injectDefaultEncoding

public static void injectDefaultEncoding(org.mule.runtime.api.meta.model.EnrichableModel model,
                                         Object target,
                                         String encoding)

Sets the encoding value into the field of the target annotated DefaultEncoding if the model contains the DeclaringMemberModelProperty property and the value is not null.

Parameters:

model - enriched with DefaultEncodingModelProperty

target - object in which the fields are going to be set

encoding - to be injected into the String field annotated with DefaultEncoding

injectRuntimeVersion

public static void injectRuntimeVersion(org.mule.runtime.api.meta.model.EnrichableModel model,
                                        Object target,
                                        org.mule.runtime.api.meta.MuleVersion muleVersion)

Sets the MuleVersion into the field of the target annotated RuntimeVersion if the model contains the DeclaringMemberModelProperty property and the value is not null.

Parameters:

model - enriched with DefaultEncodingModelProperty

target - object in which the fields are going to be set

muleVersion - MuleVersion to be injected into the MuleVersion field annotated with RuntimeVersion

injectFields

public static void injectFields(Object target,
                                String configName,
                                String encoding,
                                org.mule.runtime.api.meta.MuleVersion muleVersion,
                                ReflectionCache reflectionCache)

Sets the configName, encoding and MuleVersion into the fields of the target annotated with RefName, DefaultEncoding and RuntimeVersion respectively if present.

Parameters:

target - object in which the fields are going to be set

configName - to be injected into the String field annotated with RefName

encoding - to be injected into the String field annotated with DefaultEncoding

muleVersion - to be injected into the MuleVersion field annotated with RuntimeVersion

reflectionCache - the cache for expensive reflection lookups

Throws:

org.mule.runtime.extension.api.exception.IllegalModelDefinitionException - if there is more than one field annotated with DefaultEncoding or RuntimeVersion

injectRefName

public static void injectRefName(Object target,
                                 String configName,
                                 ReflectionCache reflectionCache)

Introspects the target object for a field annotated with RefName or RefName. If found, it injects the configName value into it.

The target object is expected to have only one field annotated with RefName or RefName and that field is required to be a String.

Parameters:

target - object in which the value are going to be set

configName - the value to be injected

reflectionCache - the cache for expensive reflection lookups

getDefaultEncodingFieldSetter

public static Optional<FieldSetter> getDefaultEncodingFieldSetter(Object target,
                                                                  ReflectionCache reflectionCache)

Returns a FieldSetter for a field in the target annotated DefaultEncoding (if present)

Parameters:

target - object in which the fields are going to be set

reflectionCache - the cache for expensive reflection lookups

Throws:

IllegalModelDefinitionException} - if there is more than one field annotated with DefaultEncoding

getRefNameFieldSetter

public static Optional<FieldSetter> getRefNameFieldSetter(Object target,
                                                          ReflectionCache reflectionCache)

Returns FieldSetter for a field in the target annotated RefName or RefName if present.

Parameters:

target - object in which the fields are going to be set

reflectionCache - the cache for expensive reflection lookups

Returns:

the FieldSetter

Throws:

org.mule.runtime.extension.api.exception.IllegalModelDefinitionException - if there is more than one field annotated with RefName and or RefName

injectComponentLocation

public static void injectComponentLocation(Object target,
                                           org.mule.runtime.api.component.location.ComponentLocation componentLocation)

Introspects the target object for a field of type ComponentLocation. If found, it injects the componentLocation value into it.

The target object is expected to have only one field of such type.

Parameters:

target - object in which the value are going to be set

componentLocation - the value to be injected

getPagingProviderTypes

public static org.mule.runtime.api.util.Pair<org.springframework.core.ResolvableType,org.springframework.core.ResolvableType> getPagingProviderTypes(org.springframework.core.ResolvableType pagingProvider)

Introspects a PagingProvider type and returns their generics.

Parameters:

pagingProvider - PagingProvider to introspect

Returns:

The PagingProvider generics.

getPagingProviderTypes

public static org.mule.runtime.api.util.Pair<Type,Type> getPagingProviderTypes(Type type)

Introspects a PagingProvider type and returns their generics.

Returns:

The PagingProvider generics.

getShowInDslParameters

public static Map<String,String> getShowInDslParameters(org.mule.runtime.api.meta.model.parameter.ParameterizedModel parameterizedModel)

Given a ParameterizedModel iterates over all the parameter groups show in dsl and returns a mapping of parameter name and parameter group name.

Parameters:

parameterizedModel - Model to introspect.

Returns:

A map with parameters from Show in DSL parameters

Since:

4.1.1

setValueIntoField

public static void setValueIntoField(Object target,
                                     Object value,
                                     String fieldName,
                                     ReflectionCache reflectionCache)

Sets the given value into the target, if it contains a field named fieldName. Nothing happens if such field doesn't exist.

Parameters:

target - the object in which the value is to be set

value - the value to set

fieldName - the name of the target field

reflectionCache - the ReflectionCache used to introspect the target

Since:

4.4.0

setValueIntoField

public static void setValueIntoField(Object target,
                                     Object value,
                                     Field field)

Sets the given value into the target field

Parameters:

target - the object in which the value is to be set

value - the value to set

field - the field in which the value is to be set

Since:

4.4.0

getFilteredParameters

public static Map<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel,Set<org.mule.runtime.api.meta.model.parameter.ParameterModel>> getFilteredParameters(org.mule.runtime.api.meta.model.ComponentModel componentModel,
                                                                                                                                                                     Predicate<org.mule.runtime.api.meta.model.parameter.ParameterModel> filter)

Returns, for each parameter group defined on the component model, all the parameters matching with the given filter

Parameters:

componentModel - the component model used to filter the parameters

filter - the filter to apply to the group model parameters

Returns:

The map having the parameter group as key and a set of its parameters matching the filter as value

getParameterOrDefault

public static <T> T getParameterOrDefault(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<? extends org.mule.runtime.api.meta.model.ComponentModel> ctx,
                                          org.mule.runtime.api.meta.model.parameter.ParameterGroupModel parameterGroupModel,
                                          org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel,
                                          T defaultValue,
                                          ReflectionCache reflectionCache)

Returns the value associated to a parameter with model parameterModel on the group parameterGroupModel or defaultValue if such parameter is not present

Type Parameters:

T - the returned value's generic type

Parameters:

ctx - the execution where to look for the parameter

parameterGroupModel - the parameter group where the parameter is defined

parameterModel - the parameter model which value will be returned

defaultValue - the default value to return in case the parameter is not present

reflectionCache - the ReflectionCache used to introspect the parameter value

Returns:

the parameter's value or defaultValue

getParameterValue

public static Object getParameterValue(Object object,
                                       org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel,
                                       ReflectionCache reflectionCache)
                                throws IllegalAccessException,
                                       NoSuchFieldException

Returns the value for the given parameter of an object instance

Parameters:

object - The object where to grab the parameter value from

parameterModel - The parameter model for the parameter to obtain the value

reflectionCache - the cache for expensive reflection lookups

Returns:

The value of the parameter with the given parameter model on the object instance

Throws:

IllegalAccessException - if is unavailable to access to the field

NoSuchFieldException - if the field doesn't exist in the given object instance

fetchConfigFieldFromSourceObject

public static Optional<Field> fetchConfigFieldFromSourceObject(Object object)

Given a Source object, fetches the Config field from the object if any.

Parameters:

object - the source object

Returns:

an Optional containing the config field if any

Since:

4.5

fetchConnectionFieldFromSourceObject

public static Optional<Field> fetchConnectionFieldFromSourceObject(Object object)

Given a Source object, fetches the Connection field from the object if any.

Parameters:

object - the source object

Returns:

an Optional containing the connection field if any

Since:

4.5