org.mule.runtime.extension.api.declaration.type

Class TypeUtils

java.lang.Object

org.mule.runtime.extension.api.declaration.type.TypeUtils

public final class TypeUtils
extends Object

Utility class to handle Java types and their relationship with the MetadataType model

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static boolean	acceptsReferences(org.mule.metadata.api.model.MetadataType metadataType)
static boolean	allowsInlineDefinition(org.mule.metadata.api.model.MetadataType type)
static boolean	allowsReferences(org.mule.metadata.api.model.MetadataType type)
static boolean	allowsTopLevelDefinition(org.mule.metadata.api.model.MetadataType type)
static String	getAlias(Field field) Checks the given field for the Alias annotation.
static Collection<Field>	getAllFields(Class<?> declaringType) Returns all the Fields in the given declaringType.
static Collection<Class<?>>	getAllSuperClasses(Class<?> type) Returns all the superclasses of the given type, without including Object
static org.mule.runtime.api.meta.ExpressionSupport	getExpressionSupport(org.mule.metadata.api.model.MetadataType metadataType) Checks the given metadataType for the ExpressionSupportAnnotation.
static Optional<org.mule.runtime.api.meta.model.display.LayoutModel>	getLayoutModel(org.mule.metadata.api.model.MetadataType metadataType)
static Collection<Field>	getParameterFields(Class<?> declaringType) Returns all the Fields in the given declaringType which are annotated with Parameter but also do not have the Ignore one.
static org.mule.runtime.api.meta.model.parameter.ParameterRole	getParameterRole(org.mule.metadata.api.model.MetadataType metadataType)
static boolean	isBasic(org.mule.metadata.api.model.MetadataType metadataType)
static boolean	isContent(org.mule.metadata.api.model.MetadataType type)
static boolean	isInfrastructure(org.mule.metadata.api.model.MetadataType type) Returns true if the type is an infrastructure type, false otherwise.

Methods inherited from class java.lang.Object

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

Method Detail

getParameterFields

public static Collection<Field> getParameterFields(Class<?> declaringType)

Returns all the Fields in the given declaringType which are annotated with Parameter but also do not have the Ignore one.

The introspection also includes parent classes.

Parameters:

declaringType - the class to introspect.

Returns:

a Collection of fields. May be empty but will never be null

getAllFields

public static Collection<Field> getAllFields(Class<?> declaringType)

Returns all the Fields in the given declaringType.

The introspection also includes parent classes.

Parameters:

declaringType - the class to introspect.

Returns:

a Collection of fields. May be empty but will never be null

getAllSuperClasses

public static Collection<Class<?>> getAllSuperClasses(Class<?> type)

Returns all the superclasses of the given type, without including Object

Parameters:

type - a type

Returns:

all the type's super classes

getAlias

public static String getAlias(Field field)

Checks the given field for the Alias annotation. If present, Alias.value() is returned. Otherwise, Field.getName() is returned.

Parameters:

field - a Field

Returns:

the field's alias

allowsInlineDefinition

public static boolean allowsInlineDefinition(org.mule.metadata.api.model.MetadataType type)

Returns:

true if the given MetadataType should support inline definition as child element

allowsTopLevelDefinition

public static boolean allowsTopLevelDefinition(org.mule.metadata.api.model.MetadataType type)

Returns:

whether the given MetadataType should support being defined as a top level element

allowsReferences

public static boolean allowsReferences(org.mule.metadata.api.model.MetadataType type)

Returns:

whether the given MetadataType should support registry references

getExpressionSupport

public static org.mule.runtime.api.meta.ExpressionSupport getExpressionSupport(org.mule.metadata.api.model.MetadataType metadataType)

Checks the given metadataType for the ExpressionSupportAnnotation.

If present, the ExpressionSupportAnnotation.getExpressionSupport() value is returned. Otherwise, it defaults to ExpressionSupport.SUPPORTED

Parameters:

metadataType - a MetadataType

Returns:

a ExpressionSupport

getParameterRole

public static org.mule.runtime.api.meta.model.parameter.ParameterRole getParameterRole(org.mule.metadata.api.model.MetadataType metadataType)

isContent

public static boolean isContent(org.mule.metadata.api.model.MetadataType type)

getLayoutModel

public static Optional<org.mule.runtime.api.meta.model.display.LayoutModel> getLayoutModel(org.mule.metadata.api.model.MetadataType metadataType)

Parameters:

metadataType - a type model

Returns:

a LayoutModel if the metadataType contains layout information

isInfrastructure

public static boolean isInfrastructure(org.mule.metadata.api.model.MetadataType type)

Returns true if the type is an infrastructure type, false otherwise.

Parameters:

type - the type to check

Returns:

whether is an infrastructure type or not.

acceptsReferences

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

Parameters:

metadataType - a type model

Returns:

whether instances of the given metadataType accept being referenced to

isBasic

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