org.mule.extension.introspection.declaration

Interface DescribingContext

public interface DescribingContext

Used for propagating state across all the components that may take part on the describing of an Extension and its DescriberPostProcessors

Once the Describer finishes applying its logic, it will propagate this context through all the found DescriberPostProcessors, which means that any side effects applied by any of the before mentioned will be visible by the next ones.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getCheckedParameter(String key, Class<T> expectedType) Obtains the custom parameter registered under key and verifies that (if not null) is of type expectedType.
Map<String,Object>	getCustomParameters() A Map to hold custom parameters that implementations of Describer and DescriberPostProcessor might want to share with each other
DeclarationDescriptor	getDeclarationDescriptor() The DeclarationDescriptor in which the extension is being described into

Method Detail

getDeclarationDescriptor

DeclarationDescriptor getDeclarationDescriptor()

The DeclarationDescriptor in which the extension is being described into

Returns:

a non null DeclarationDescriptor

getCustomParameters

Map<String,Object> getCustomParameters()

A Map to hold custom parameters that implementations of Describer and DescriberPostProcessor might want to share with each other

Returns:

a non null map. Not be assumed thread-safe

getCheckedParameter

<T> T getCheckedParameter(String key,
                        Class<T> expectedType)

Obtains the custom parameter registered under key and verifies that (if not null) is of type expectedType. If the obtained value if not an instance of such type, an IllegalArgumentException is thrown. If no value is registered under that key, then it simply returns null

Type Parameters:

T - generic type of the expected value

Parameters:

key - the key under which the wanted value is registered

expectedType - the type of the expected value

Returns:

an instance of expectedType or null