org.mule.runtime.api.dsl

Interface DslResolvingContext

All Known Implementing Classes:

DefaultDslResolvingContext, NullDslResolvingContext

public interface DslResolvingContext

Context used to discover the ExtensionModels required to generate the DSL related views of a given component.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static DslResolvingContext	getDefault(Set<ExtensionModel> extensions) Provides the default implementation of DslResolvingContext based on a given Set of ExtensionModel
Optional<ExtensionModel>	getExtension(String name) Returns an Optional ExtensionModel which name equals the provided name.
Optional<ExtensionModel>	getExtensionForType(String typeId) Returns an Optional ExtensionModel that declared the given type.
Set<ExtensionModel>	getExtensions() Returns a Set containing all the ExtensionModels available in the current resolving context.
TypeCatalog	getTypeCatalog() Returns a TypeCatalog containing all the ObjectTypes available in the current resolving context.

Method Detail

getDefault

static DslResolvingContext getDefault(Set<ExtensionModel> extensions)

Provides the default implementation of DslResolvingContext based on a given Set of ExtensionModel

Parameters:

extensions - the Set of ExtensionModel available in this DslResolvingContext

Returns:

an instance of a DslResolvingContext default implementation

getExtension

Optional<ExtensionModel> getExtension(String name)

Returns an Optional ExtensionModel which name equals the provided name.

Parameters:

name - the name of the extensions you want.

Returns:

an Optional. It will be empty if the ExtensionModel is not found in the context.

getExtensionForType

Optional<ExtensionModel> getExtensionForType(String typeId)

Returns an Optional ExtensionModel that declared the given type.

Parameters:

typeId - that was declared

Returns:

an Optional. It will be empty if the ExtensionModel is not found in the context.

getExtensions

Set<ExtensionModel> getExtensions()

Returns a Set containing all the ExtensionModels available in the current resolving context.

Any ExtensionModel that can be found using the getExtension(java.lang.String) method should be contained in the returned Set

Returns:

a Set containing all the ExtensionModels available in the current resolving context

getTypeCatalog

TypeCatalog getTypeCatalog()

Returns a TypeCatalog containing all the ObjectTypes available in the current resolving context.

Any ObjectType that can be found using the ExtensionModel.getTypes() method for any of the extensions in the context should available in the provided TypeCatalog

Returns:

a TypeCatalog containing all the ObjectTypes available in the current resolving context.