org.mule.tooling.client.api.extension.model

Interface ComponentModel

All Known Implementing Classes:

ConstructModel, OperationModel, SourceModel

public interface ComponentModel

A definition of a component in an ExtensionModel. This model groups all the common contracts between extension components like OperationModel, SourceModel, etc.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default List<ParameterModel>	getAllParameterModels() Returns all the parameters on all groups.
String	getDescription() Returns the component's description
Optional<DisplayModel>	getDisplayModel()
Set<ErrorModel>	getErrorModels()
String	getName() Gets the name of the object
List<? extends NestableElementModel>	getNestedComponents()
List<ParameterGroupModel>	getParameterGroupModels()
StereotypeModel	getStereotype()

Method Detail

getName

String getName()

Gets the name of the object

Returns:

the name of the object

getDescription

String getDescription()

Returns the component's description

Returns:

a non blank String

getParameterGroupModels

List<ParameterGroupModel> getParameterGroupModels()

Returns:

a of groups

getAllParameterModels

default List<ParameterModel> getAllParameterModels()

Returns all the parameters on all groups.

Returns:

a flattened list of all the parameters in this model

getNestedComponents

List<? extends NestableElementModel> getNestedComponents()

Returns:

the List of components contained by this model

getStereotype

StereotypeModel getStereotype()

Returns:

The stereotypes which apply to this model

getDisplayModel

Optional<DisplayModel> getDisplayModel()

Returns:

An Optional DisplayModel which contains directives about how this model should be displayed in the UI

getErrorModels

Set<ErrorModel> getErrorModels()

Returns:

a Set of ErrorModel with the possible errors that the current component could throw.

See Also:

ErrorModel