Module org.mule.sdk.api
Package org.mule.sdk.api.metadata.resolving

Interface OutputTypeResolver<K>

Type Parameters:
K - the generic type of the objects to be used as MetadataKeyId representing a type structure
All Superinterfaces:
NamedTypeResolver
All Known Implementing Classes:
NullMetadataResolver, OutputStaticTypeResolver
@MinMuleVersion("4.5.0") public interface OutputTypeResolver<K> extends NamedTypeResolver
Handles the dynamic MetadataType resolving for the output of an associated component.
Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    org.mule.metadata.api.model.MetadataType
    getOutputType(MetadataContext context, K key)
    Given an instance of type K, resolves their MetadataType, which represents the type structure.
    default String
    getResolverName()
    This is the name of the TypeResolver.

    Methods inherited from interface org.mule.sdk.api.metadata.resolving.NamedTypeResolver

    getCategoryName

  • Method Details

    • getResolverName

      default String getResolverName()
      This is the name of the TypeResolver. It should not be repeated among InputTypeResolver and OutputTypeResolver which are used together.
      Specified by:
      getResolverName in interface NamedTypeResolver
      Returns:
      name of the resolver

    • getOutputType

      org.mule.metadata.api.model.MetadataType getOutputType(MetadataContext context, K key) throws org.mule.runtime.api.metadata.MetadataResolvingException, org.mule.runtime.api.connection.ConnectionException
      Given an instance of type K, resolves their MetadataType, which represents the type structure. This MetadataType will be considered as the output or result of the Component
      Parameters:
      context - MetadataContext of the MetaData resolution
      key - K representing the type which's structure has to be resolved
      Returns:
      MetadataType from the given
      Throws:
      org.mule.runtime.api.metadata.MetadataResolvingException - if an error occurs during the MetadataType building. See FailureCode for possible MetadataResolvingException reasons
      org.mule.runtime.api.connection.ConnectionException - if an error occurs when using the connection provided by the MetadataContext