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

Interface Type

All Superinterfaces:

WithAlias, WithAnnotations, WithDeclaringClass, WithElement

All Known Subinterfaces:

ComponentElement, ConfigurationElement, ConnectionProviderElement, ExtensionElement, FunctionContainerElement, OperationContainerElement, ParameterizableTypeElement, SourceElement

All Known Implementing Classes:

ConnectionProviderTypeWrapper, ExtensionTypeWrapper, ParameterizableTypeWrapper, ParameterTypeWrapper, SourceTypeWrapper, TypeWrapper

@NoImplement
public interface Type
extends WithAnnotations, WithAlias, WithDeclaringClass, WithElement

A generic contract for any kind of component that is based on a Class

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
org.mule.metadata.api.model.MetadataType	asMetadataType()
List<FieldElement>	getAnnotatedFields(Class<? extends Annotation>... annotations)
org.mule.metadata.java.api.annotation.ClassInformationAnnotation	getClassInformation()
Optional<TypeElement>	getElement()
List<FieldElement>	getFields()
List<TypeGeneric>	getGenerics()
default List<Type>	getInterfaceGenerics(Class interfaceType) Deprecated.
Optional<MethodElement>	getMethod(String name, Class<?>... parameterTypes)
String	getName() Returns the component's name
List<PropertyElement>	getProperties()
Optional<Type>	getSuperType() Returns a Type representing the class that this type directly extends.
List<Type>	getSuperTypeGenerics(Class superType)
String	getTypeName()
boolean	isAnyType()
boolean	isAssignableFrom(Class<?> clazz) Checks the assignability of the current type from the given Class
boolean	isAssignableFrom(Type type) Checks the assignability of the current type from the given Type
boolean	isAssignableTo(Class<?> clazz) Checks the assignability of the current type to the given Class
boolean	isAssignableTo(Type type) Checks the assignability of the current type to the given Type
boolean	isInstantiable()
boolean	isSameType(Class<?> clazz) Checks equality of the current type to the given Class
boolean	isSameType(Type type) Checks equality of the current type to the given Type

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

getFields

List<FieldElement> getFields()

Returns:

A list of FieldElement that represent the list of Field that the Type declares

getProperties

List<PropertyElement> getProperties()

Returns:

A list of FieldElement that represent the list of Field propertyes that the Type declares

getAnnotatedFields

List<FieldElement> getAnnotatedFields(Class<? extends Annotation>... annotations)

Parameters:

annotations - classes that the fields of this type should be annotated with

Returns:

A list of FieldElement that represent the list of Field that the Type declares and are annotated with the given annotation

isAssignableFrom

boolean isAssignableFrom(Class<?> clazz)

Checks the assignability of the current type from the given Class

Parameters:

clazz - The class to check

Returns:

a boolean indicating whether the type is assignable or not from the given class

Since:

4.1

isAssignableFrom

boolean isAssignableFrom(Type type)

Checks the assignability of the current type from the given Type

Parameters:

type - The type to check

Returns:

a boolean indicating whether the type is assignable or not to the given Type

Since:

4.1

isAssignableTo

boolean isAssignableTo(Class<?> clazz)

Checks the assignability of the current type to the given Class

Parameters:

clazz - The class to check

Returns:

a boolean indicating whether the type is assignable or not to the given class

Since:

4.1

isAssignableTo

boolean isAssignableTo(Type type)

Checks the assignability of the current type to the given Type

Parameters:

type - The type to check

Returns:

a boolean indicating whether the type is assignable or not to the given Type

Since:

4.1

isSameType

boolean isSameType(Type type)

Checks equality of the current type to the given Type

Parameters:

type - The type to check equality

Returns:

a boolean indicating whether the type is the same type or not

Since:

4.1

isSameType

boolean isSameType(Class<?> clazz)

Checks equality of the current type to the given Class

Parameters:

clazz - The type to check equality

Returns:

a boolean indicating whether the type is the same type or not

Since:

4.1

isInstantiable

boolean isInstantiable()

Returns:

a boolean indicating if the current type is instantiable or not.

Since:

4.1

getGenerics

List<TypeGeneric> getGenerics()

Returns:

The generics for the current type.

Since:

4.1

getSuperTypeGenerics

List<Type> getSuperTypeGenerics(Class superType)

Parameters:

superType - The Class with generics, this can be a Interface or a normal Class

Returns:

The list of generics types from the given super type class.

Since:

4.1.2

getInterfaceGenerics

@Deprecated
default List<Type> getInterfaceGenerics(Class interfaceType)

Deprecated.

Parameters:

interfaceType - The Class with generics

Returns:

The list of generics types from the given interface class.

Since:

4.1

asMetadataType

org.mule.metadata.api.model.MetadataType asMetadataType()

Returns:

The current type described as a MetadataType

Since:

4.1

getTypeName

String getTypeName()

getSuperType

Optional<Type> getSuperType()

Returns a Type representing the class that this type directly extends. If either this or the resolved super type match the Object type then Optional.empty() is returned

Returns:

the super type

Since:

4.5.0

getClassInformation

org.mule.metadata.java.api.annotation.ClassInformationAnnotation getClassInformation()

Returns:

The ClassInformationAnnotation describing the current Type

Since:

4.1

isAnyType

boolean isAnyType()

Returns:

A boolean indicating if this type may be considered as an AnyType

Since:

4.1

getElement

Optional<TypeElement> getElement()

Specified by:

getElement in interface WithElement

Returns:

an Optional Element representing the component that implements this interface.

getMethod

Optional<MethodElement> getMethod(String name,
                                  Class<?>... parameterTypes)

Parameters:

name -

parameterTypes -

Returns:

The MethodElement if present

Since:

4.2

getName

String getName()

Returns the component's name

Returns:

a non blank String