Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.dsl.syntax

Class XmlDslSyntaxResolver

java.lang.Object

org.mule.runtime.extension.api.dsl.syntax.XmlDslSyntaxResolver

All Implemented Interfaces:

DslSyntaxResolver

public class XmlDslSyntaxResolver
extends Object
implements DslSyntaxResolver

Default implementation of a DslSyntaxResolver based on XML.

Provides the DslElementSyntax of any Component, Parameter or Type within the context of the Extension model where the Component was declared.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
XmlDslSyntaxResolver(org.mule.runtime.api.meta.model.ExtensionModel model, org.mule.runtime.api.dsl.DslResolvingContext context)	Creates an instance using the default implementation
XmlDslSyntaxResolver(org.mule.runtime.api.meta.model.ExtensionModel model, ImportTypesStrategy importTypesStrategy)	Creates an instance using the default implementation

Method Summary

Modifier and Type	Method	Description
Optional<DslElementSyntax>	resolve(org.mule.metadata.api.model.MetadataType type)	Resolves the DslElementSyntax for the standalone xml element for the given MetadataType
DslElementSyntax	resolve(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter)	Resolves the DslElementSyntax for the given parameter, providing all the required information for representing this parameter element in the DSL.
DslElementSyntax	resolve(org.mule.runtime.api.meta.NamedObject component)	Resolves the DslElementSyntax for the given component.
DslElementSyntax	resolveInline(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel group)	Resolves the DslElementSyntax for a ParameterGroupModel that has to be shown as an inline element of the DSL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XmlDslSyntaxResolver

public XmlDslSyntaxResolver(org.mule.runtime.api.meta.model.ExtensionModel model,
 org.mule.runtime.api.dsl.DslResolvingContext context)

Creates an instance using the default implementation

Parameters:

model - the ExtensionModel that provides context for resolving the component's DslElementSyntax

context - the DslResolvingContext in which the Dsl resolution takes place

Throws:

IllegalArgumentException - if the ExtensionModel declares an imported type from an ExtensionModel not present in the provided DslResolvingContext or if the imported ExtensionModel doesn't have any ImportedTypeModel

XmlDslSyntaxResolver

public XmlDslSyntaxResolver(org.mule.runtime.api.meta.model.ExtensionModel model,
 ImportTypesStrategy importTypesStrategy)

Creates an instance using the default implementation

Parameters:

model - the ExtensionModel that provides context for resolving the component's DslElementSyntax

importTypesStrategy - the ImportTypesStrategy used for external types resolution

Throws:

IllegalArgumentException - if the ExtensionModel declares an imported type from an ExtensionModel not present in the provided DslResolvingContext or if the imported ExtensionModel doesn't have any ImportedTypeModel

Method Details

resolve

public DslElementSyntax resolve(org.mule.runtime.api.meta.NamedObject component)

Resolves the DslElementSyntax for the given component.

Specified by:

resolve in interface DslSyntaxResolver

Parameters:

component - the NamedObject element to be described in the DslElementSyntax

Returns:

the DslElementSyntax for the model

resolve

public DslElementSyntax resolve(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter)

Resolves the DslElementSyntax for the given parameter, providing all the required information for representing this parameter element in the DSL.

Specified by:

resolve in interface DslSyntaxResolver

Parameters:

parameter - the ParameterModel to be described in the DslElementSyntax

Returns:

the DslElementSyntax for the parameter

resolveInline

public DslElementSyntax resolveInline(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel group)

Resolves the DslElementSyntax for a ParameterGroupModel that has to be shown as an inline element of the DSL

Specified by:

resolveInline in interface DslSyntaxResolver

Parameters:

group - the ParameterGroupModel to be described in the DslElementSyntax

Returns:

the DslElementSyntax for the group

resolve

public Optional<DslElementSyntax> resolve(org.mule.metadata.api.model.MetadataType type)

Resolves the DslElementSyntax for the standalone xml element for the given MetadataType

Specified by:

resolve in interface DslSyntaxResolver

Parameters:

type - the MetadataType to be described in the DslElementSyntax

Returns:

the DslElementSyntax for the top level element associated to the MetadataType or Optional.empty() if the type is not supported as an standalone element