org.mule.runtime.api.metadata.descriptor

Class OutputMetadataDescriptor.OutputMetadataDescriptorBuilder

java.lang.Object

org.mule.runtime.api.metadata.descriptor.OutputMetadataDescriptor.OutputMetadataDescriptorBuilder

Enclosing class:

OutputMetadataDescriptor

public static class OutputMetadataDescriptor.OutputMetadataDescriptorBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
OutputMetadataDescriptor	build()
OutputMetadataDescriptor.OutputMetadataDescriptorBuilder	withAttributesType(org.mule.metadata.api.model.MetadataType attributesType) Describes that the output Message.getAttributes() MetadataType of the component will be
OutputMetadataDescriptor.OutputMetadataDescriptorBuilder	withAttributesType(TypeMetadataDescriptor attributesTypeResult) Adds a MetadataResult of TypeMetadataDescriptor that describes the he output Message.getAttributes() MetadataType.
OutputMetadataDescriptor.OutputMetadataDescriptorBuilder	withReturnType(org.mule.metadata.api.model.MetadataType returnType) Describes that the return type of the component will be of MetadataType
OutputMetadataDescriptor.OutputMetadataDescriptorBuilder	withReturnType(TypeMetadataDescriptor returnTypeResult) Adds a MetadataResult of TypeMetadataDescriptor that describes the return type of the component.

Methods inherited from class java.lang.Object

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

Method Detail

withReturnType

public OutputMetadataDescriptor.OutputMetadataDescriptorBuilder withReturnType(TypeMetadataDescriptor returnTypeResult)

Adds a MetadataResult of TypeMetadataDescriptor that describes the return type of the component.

Parameters:

returnTypeResult - a MetadataResult of TypeMetadataDescriptor describing the component output return type

Returns:

the builder instance enriched with the TypeMetadataDescriptor for return type

withAttributesType

public OutputMetadataDescriptor.OutputMetadataDescriptorBuilder withAttributesType(TypeMetadataDescriptor attributesTypeResult)

Adds a MetadataResult of TypeMetadataDescriptor that describes the he output Message.getAttributes() MetadataType.

Parameters:

attributesTypeResult - a MetadataResult of TypeMetadataDescriptor describing the component output attributes type.

Returns:

the builder instance enriched with the TypeMetadataDescriptor for message attributes

withReturnType

public OutputMetadataDescriptor.OutputMetadataDescriptorBuilder withReturnType(org.mule.metadata.api.model.MetadataType returnType)

Describes that the return type of the component will be of MetadataType

Parameters:

returnType - of the component returnTypeResult output

Returns:

the builder instance enriched with the TypeMetadataDescriptor for return type

withAttributesType

public OutputMetadataDescriptor.OutputMetadataDescriptorBuilder withAttributesType(org.mule.metadata.api.model.MetadataType attributesType)

Describes that the output Message.getAttributes() MetadataType of the component will be

Parameters:

attributesType - of the component output attributes

Returns:

the builder instance enriched with the TypeMetadataDescriptor for message attributes

build

public OutputMetadataDescriptor build()

Returns:

a OutputMetadataDescriptor instance with the metadata description for the output of a MetadataProvider component

Throws:

IllegalArgumentException - if the Message.getPayload() or Message.getAttributes() were not set during building