Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.dsl.syntax.resolver

Interface DslSyntaxResolver

All Known Implementing Classes:
XmlDslSyntaxResolver
public interface DslSyntaxResolver
Provides the DslElementSyntax of any Component, Parameter or Type within the context of the Extension model where the Component was declared.
Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    static DslSyntaxResolver
    getDefault(org.mule.runtime.api.meta.model.ExtensionModel model, org.mule.runtime.api.dsl.DslResolvingContext context)
    Creates an instance using the default implementation
    static DslSyntaxResolver
    getDefault(org.mule.runtime.api.meta.model.ExtensionModel model, ImportTypesStrategy importTypesStrategy)
    Creates an instance using the default implementation
    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

  • Method Details

    • resolve

      DslElementSyntax resolve(org.mule.runtime.api.meta.NamedObject component)
      Resolves the DslElementSyntax for the given component.
      Parameters:
      component - the NamedObject element to be described in the DslElementSyntax
      Returns:
      the DslElementSyntax for the model

    • resolve

      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.
      Parameters:
      parameter - the ParameterModel to be described in the DslElementSyntax
      Returns:
      the DslElementSyntax for the parameter

    • resolve

      Optional<DslElementSyntax> resolve(org.mule.metadata.api.model.MetadataType type)
      Resolves the DslElementSyntax for the standalone xml element for the given MetadataType
      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

    • resolveInline

      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
      Parameters:
      group - the ParameterGroupModel to be described in the DslElementSyntax
      Returns:
      the DslElementSyntax for the group

    • getDefault

      static DslSyntaxResolver getDefault(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
      Returns:
      the default implementation of a DslSyntaxResolver
      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

    • getDefault

      static DslSyntaxResolver getDefault(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
      Returns:
      the default implementation of a DslSyntaxResolver
      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