Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.model

Class AbstractComponentModel

java.lang.Object

org.mule.runtime.extension.api.model.AbstractImmutableModel

org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

org.mule.runtime.extension.api.model.parameter.AbstractParameterizedModel

org.mule.runtime.extension.api.model.parameter.AbstractStereotypedModel

org.mule.runtime.extension.api.model.AbstractComponentModel

All Implemented Interfaces:

org.mule.runtime.api.meta.DescribedObject, org.mule.runtime.api.meta.model.ComponentModel, org.mule.runtime.api.meta.model.ComposableModel, org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms, org.mule.runtime.api.meta.model.deprecated.DeprecableModel, org.mule.runtime.api.meta.model.display.HasDisplayModel, org.mule.runtime.api.meta.model.EnrichableModel, org.mule.runtime.api.meta.model.error.ThrowsErrors, org.mule.runtime.api.meta.model.parameter.ParameterizedModel, org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel, org.mule.runtime.api.meta.model.version.HasMinMuleVersion, org.mule.runtime.api.meta.NamedObject

Direct Known Subclasses:

AbstractExecutableComponentModel, ImmutableConstructModel, ImmutableNestedComponentModel, ImmutableNestedRouteModel

public abstract class AbstractComponentModel
extends AbstractStereotypedModel
implements org.mule.runtime.api.meta.model.ComponentModel

Base class for immutable implementations of a ComponentModel

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

description, modelProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, org.mule.runtime.api.meta.model.ComponentVisibility visibility, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)	Creates a new instance
protected	AbstractComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, org.mule.runtime.api.meta.model.ComponentVisibility visibility, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)	Creates a new instance
protected	AbstractComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, org.mule.runtime.api.meta.model.ComponentVisibility visibility, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, Set<String> semanticTerms)	Creates a new instance
protected	AbstractComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, org.mule.runtime.api.meta.model.ComponentVisibility visibility, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, Set<String> semanticTerms, org.mule.runtime.api.meta.MuleVersion minMuleVersion)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
Set<org.mule.runtime.api.meta.model.error.ErrorModel>	getErrorModels()
List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel>	getNestedComponents()
Set<String>	getSemanticTerms()
org.mule.runtime.api.meta.model.ComponentVisibility	getVisibility()
String	toString()

Methods inherited from class org.mule.runtime.extension.api.model.parameter.AbstractStereotypedModel

getDeprecationModel, getMinMuleVersion, getStereotype, isDeprecated

Methods inherited from class org.mule.runtime.extension.api.model.parameter.AbstractParameterizedModel

getParameterGroupModels

Methods inherited from class org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

checkArgument, equals, getDisplayModel, getName, hashCode

Methods inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

copy, copy, getDescription, getModelProperties, getModelProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.runtime.api.meta.model.ComponentModel

accept

Methods inherited from interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

getDeprecationModel, isDeprecated

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.model.version.HasMinMuleVersion

getMinMuleVersion

Methods inherited from interface org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel

getStereotype

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.model.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

Constructor Details

AbstractComponentModel

protected AbstractComponentModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
 org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
 org.mule.runtime.api.meta.model.ComponentVisibility visibility,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

nestedComponents - a List with the components contained by this model

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

visibility - the model's ComponentVisibility

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if name is blank

AbstractComponentModel

protected AbstractComponentModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
 org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
 org.mule.runtime.api.meta.model.ComponentVisibility visibility,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
 org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

nestedComponents - a List with the components contained by this model

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

visibility - the model's ComponentVisibility

modelProperties - A Set of custom properties which extend this model

deprecationModel - a DeprecationModel describing if the component is deprecated. A null value means it is not deprecated.

Throws:

IllegalArgumentException - if name is blank

AbstractComponentModel

protected AbstractComponentModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
 org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
 org.mule.runtime.api.meta.model.ComponentVisibility visibility,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
 org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel,
 Set<String> semanticTerms)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

nestedComponents - a List with the components contained by this model

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

visibility - the model's ComponentVisibility

modelProperties - A Set of custom properties which extend this model

deprecationModel - a DeprecationModel describing if the component is deprecated. A null value means it is not deprecated.

semanticTerms - a Set of semantic terms which describe the component's meaning and effect

Throws:

IllegalArgumentException - if name is blank

Since:

1.4.0

AbstractComponentModel

protected AbstractComponentModel(String name,
 String description,
 List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
 List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
 org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
 Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
 org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
 org.mule.runtime.api.meta.model.ComponentVisibility visibility,
 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
 org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel,
 Set<String> semanticTerms,
 org.mule.runtime.api.meta.MuleVersion minMuleVersion)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

nestedComponents - a List with the components contained by this model

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

visibility - the model's ComponentVisibility

modelProperties - A Set of custom properties which extend this model

deprecationModel - a DeprecationModel describing if the component is deprecated. A null value means it is not deprecated.

semanticTerms - a Set of semantic terms which describe the component's meaning and effect

minMuleVersion - the min mule version of the component

Throws:

IllegalArgumentException - if name is blank

Since:

1.5.0

Method Details

getErrorModels

public Set<org.mule.runtime.api.meta.model.error.ErrorModel> getErrorModels()

Specified by:

getErrorModels in interface org.mule.runtime.api.meta.model.error.ThrowsErrors

getNestedComponents

public List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> getNestedComponents()

Specified by:

getNestedComponents in interface org.mule.runtime.api.meta.model.ComposableModel

getSemanticTerms

public Set<String> getSemanticTerms()

Specified by:

getSemanticTerms in interface org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms

Since:

1.4.0

getVisibility

public org.mule.runtime.api.meta.model.ComponentVisibility getVisibility()

Specified by:

getVisibility in interface org.mule.runtime.api.meta.model.ComponentModel

toString

public String toString()

Overrides:

toString in class AbstractStereotypedModel