org.mule.runtime.extension.api.model.nested

Class ImmutableNestedComponentModel

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

org.mule.runtime.extension.api.model.nested.ImmutableNestedComponentModel

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.nested.NestableElementModel, org.mule.runtime.api.meta.model.nested.NestedComponentModel, org.mule.runtime.api.meta.model.parameter.ParameterizedModel, org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel, org.mule.runtime.api.meta.NamedObject

Direct Known Subclasses:

ImmutableNestedChainModel

public class ImmutableNestedComponentModel
extends AbstractComponentModel
implements org.mule.runtime.api.meta.model.nested.NestedComponentModel

Immutable concrete implementation of NestedComponentModel

Since:

1.0

Field Summary

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

description, modelProperties

Constructor Summary

Constructors

Constructor and Description
ImmutableNestedComponentModel(String name, String description, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, boolean isRequired, Set<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypes, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Creates a new instance
ImmutableNestedComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, int minOccurs, Integer maxOccurs, Set<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypes, 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, 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

Method Summary

Modifier and Type	Method and Description
void	accept(org.mule.runtime.api.meta.model.ComponentModelVisitor visitor)
void	accept(org.mule.runtime.api.meta.model.nested.NestableElementModelVisitor visitor)
Set<org.mule.runtime.api.meta.model.stereotype.StereotypeModel>	getAllowedStereotypes()
Optional<Integer>	getMaxOccurs()
int	getMinOccurs()
boolean	isRequired()

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

getErrorModels, getNestedComponents, getSemanticTerms

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

getDeprecationModel, 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, toString

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.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

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

getDescription

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

getNestedComponents

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

getName

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

getStereotype

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.error.ThrowsErrors

getErrorModels

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

getDeprecationModel, isDeprecated

Methods inherited from interface org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms

getSemanticTerms

Constructor Detail

ImmutableNestedComponentModel

public ImmutableNestedComponentModel(String name,
                                     String description,
                                     org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                     boolean isRequired,
                                     Set<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypes,
                                     Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

isRequired - whether or not this component is required

allowedStereotypes - A Set of custom properties which extend this model

displayModel - a model containing directives about how this component is to be displayed in the UI

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if name is blank

ImmutableNestedComponentModel

public ImmutableNestedComponentModel(String name,
                                     String description,
                                     List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                                     int minOccurs,
                                     Integer maxOccurs,
                                     Set<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> allowedStereotypes,
                                     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,
                                     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

minOccurs - the minimum number of instances required for this component

maxOccurs - maximum amount of times that this component can be used inside the owning one. null means unbounded.

allowedStereotypes - a Set with the StereotypeModels that can be assigned to this nested element.

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

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

Method Detail

getAllowedStereotypes

public Set<org.mule.runtime.api.meta.model.stereotype.StereotypeModel> getAllowedStereotypes()

Specified by:

getAllowedStereotypes in interface org.mule.runtime.api.meta.model.nested.NestedComponentModel

isRequired

public boolean isRequired()

Specified by:

isRequired in interface org.mule.runtime.api.meta.model.nested.NestableElementModel

Specified by:

isRequired in interface org.mule.runtime.api.meta.model.nested.NestedComponentModel

getMinOccurs

public int getMinOccurs()

Specified by:

getMinOccurs in interface org.mule.runtime.api.meta.model.nested.NestableElementModel

Since:

1.4.0

getMaxOccurs

public Optional<Integer> getMaxOccurs()

Specified by:

getMaxOccurs in interface org.mule.runtime.api.meta.model.nested.NestableElementModel

Since:

1.4.0

accept

public void accept(org.mule.runtime.api.meta.model.ComponentModelVisitor visitor)

Specified by:

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

Since:

1.4.0

accept

public void accept(org.mule.runtime.api.meta.model.nested.NestableElementModelVisitor visitor)

Specified by:

accept in interface org.mule.runtime.api.meta.model.nested.NestableElementModel