org.mule.runtime.extension.api.introspection.declaration

Interface DescribingContext

public interface DescribingContext

Used for propagating state across all the components that may take part on the describing of an ExtensionModel

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	addParameter(String key, Object value) Adds a custom parameter registered under key
ExtensionDeclarer	getExtensionDeclarer() The ExtensionDeclarer in which the extension is being described into
<T> T	getParameter(String key, Class<T> expectedType) Obtains the custom parameter registered under key and verifies that (if not null) is of type expectedType.

Method Detail

getExtensionDeclarer

ExtensionDeclarer getExtensionDeclarer()

The ExtensionDeclarer in which the extension is being described into

Returns:

a non null ExtensionDeclarer

addParameter

void addParameter(String key,
                  Object value)

Adds a custom parameter registered under key

Parameters:

key - the key under which the value is to be registered

value - the custom parameter value

Throws:

IllegalArgumentException - if key or value are null

getParameter

<T> T getParameter(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