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

Class ConstructModel

java.lang.Object

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

All Implemented Interfaces:

ComponentModel, ParameterizedModel, HasSemanticTerms

public class ConstructModel
extends Object
implements ComponentModel

DTO for a ConstructModel.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ConstructModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, DisplayModel displayModel, StereotypeModel stereotype, List<? extends NestableElementModel> nestedComponents, boolean allowsTopLevelDefinition, Set<ErrorModel> errorModels, DeprecationModel deprecationModel) Deprecated.
ConstructModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, DisplayModel displayModel, StereotypeModel stereotype, List<? extends NestableElementModel> nestedComponents, boolean allowsTopLevelDefinition, Set<ErrorModel> errorModels, DeprecationModel deprecationModel, TypeResolversInformationModel typeResolversInformationModel) Creates a new instance with the given state
ConstructModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, DisplayModel displayModel, StereotypeModel stereotype, List<? extends NestableElementModel> nestedComponents, boolean allowsTopLevelDefinition, Set<ErrorModel> errorModels, DeprecationModel deprecationModel, TypeResolversInformationModel typeResolversInformationModel, Set<String> semanticTerms) Creates a new instance with the given state

Method Summary

Modifier and Type	Method and Description
boolean	allowsTopLevelDeclaration()
boolean	equals(Object obj)
Feature<DeprecationModel>	getDeprecationModel()
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()
Optional<ParameterGroupModel>	getParameterGroupModel(String name)
List<ParameterGroupModel>	getParameterGroupModels()
Set<String>	getSemanticTerms() Returns the semantic terms contained in this model.
StereotypeModel	getStereotype()
Feature<TypeResolversInformationModel>	getTypeResolversInformationModel()
int	hashCode()
boolean	isAllowsTopLevelDefinition()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.tooling.client.api.extension.model.ParameterizedModel

getAllParameterModels

Constructor Detail

ConstructModel

@Deprecated
public ConstructModel(String name,
                                  String description,
                                  List<ParameterGroupModel> parameterGroupModels,
                                  DisplayModel displayModel,
                                  StereotypeModel stereotype,
                                  List<? extends NestableElementModel> nestedComponents,
                                  boolean allowsTopLevelDefinition,
                                  Set<ErrorModel> errorModels,
                                  DeprecationModel deprecationModel)

Deprecated.

ConstructModel

public ConstructModel(String name,
                      String description,
                      List<ParameterGroupModel> parameterGroupModels,
                      DisplayModel displayModel,
                      StereotypeModel stereotype,
                      List<? extends NestableElementModel> nestedComponents,
                      boolean allowsTopLevelDefinition,
                      Set<ErrorModel> errorModels,
                      DeprecationModel deprecationModel,
                      TypeResolversInformationModel typeResolversInformationModel)

Creates a new instance with the given state

Parameters:

name - the operation's name. Cannot be blank

description - the operation's descriptor

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

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

stereotype - the construct StereotypeModel

nestedComponents - a List with the components contained by this model

allowsTopLevelDefinition - whether or not this model can be declared as a root component in the application

errorModels - Set of ErrorModel error models

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

typeResolversInformationModel - TypeResolversInformationModel with information about metadata resolvers for this component.

Throws:

IllegalArgumentException - if name is blank or executorFactory is null

ConstructModel

public ConstructModel(String name,
                      String description,
                      List<ParameterGroupModel> parameterGroupModels,
                      DisplayModel displayModel,
                      StereotypeModel stereotype,
                      List<? extends NestableElementModel> nestedComponents,
                      boolean allowsTopLevelDefinition,
                      Set<ErrorModel> errorModels,
                      DeprecationModel deprecationModel,
                      TypeResolversInformationModel typeResolversInformationModel,
                      Set<String> semanticTerms)

Creates a new instance with the given state

Parameters:

name - the operation's name. Cannot be blank

description - the operation's descriptor

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

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

stereotype - the construct StereotypeModel

nestedComponents - a List with the components contained by this model

allowsTopLevelDefinition - whether or not this model can be declared as a root component in the application

errorModels - Set of ErrorModel error models

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

typeResolversInformationModel - TypeResolversInformationModel with information about metadata resolvers for this component.

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

Throws:

IllegalArgumentException - if name is blank or executorFactory is null

Since:

1.4.0

Method Detail

allowsTopLevelDeclaration

public boolean allowsTopLevelDeclaration()

getName

public String getName()

Description copied from interface: ComponentModel

Gets the name of the object

Specified by:

getName in interface ComponentModel

Returns:

the name of the object

getDescription

public String getDescription()

Description copied from interface: ComponentModel

Returns the component's description

Specified by:

getDescription in interface ComponentModel

Returns:

a non blank String

getParameterGroupModels

public List<ParameterGroupModel> getParameterGroupModels()

Specified by:

getParameterGroupModels in interface ParameterizedModel

Returns:

a of groups

getDisplayModel

public Optional<DisplayModel> getDisplayModel()

Specified by:

getDisplayModel in interface ComponentModel

Returns:

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

getStereotype

public StereotypeModel getStereotype()

Specified by:

getStereotype in interface ComponentModel

Returns:

The stereotypes which apply to this model

getNestedComponents

public List<? extends NestableElementModel> getNestedComponents()

Specified by:

getNestedComponents in interface ComponentModel

Returns:

the List of components contained by this model

isAllowsTopLevelDefinition

public boolean isAllowsTopLevelDefinition()

getErrorModels

public Set<ErrorModel> getErrorModels()

Specified by:

getErrorModels in interface ComponentModel

Returns:

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

See Also:

ErrorModel

getTypeResolversInformationModel

public Feature<TypeResolversInformationModel> getTypeResolversInformationModel()

Specified by:

getTypeResolversInformationModel in interface ComponentModel

Returns:

a TypeResolversInformationModel with the information about the resolvers for metadata types.

getDeprecationModel

public Feature<DeprecationModel> getDeprecationModel()

getSemanticTerms

public Set<String> getSemanticTerms()

Description copied from interface: HasSemanticTerms

Returns the semantic terms contained in this model. This could have been a Feature but instead, implementations should handle the cases where coming from an older version by returning an Collections.emptySet()

Specified by:

getSemanticTerms in interface HasSemanticTerms

getParameterGroupModel

public Optional<ParameterGroupModel> getParameterGroupModel(String name)

Specified by:

getParameterGroupModel in interface ParameterizedModel

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object