org.mule.runtime.api.metadata.descriptor.builder

Class OutputMetadataDescriptorBuilder

java.lang.Object

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

public class OutputMetadataDescriptorBuilder
extends Object

Implementation of the builder design pattern to create instances of OutputMetadataDescriptor

Since:

1.0

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

withReturnType

public OutputMetadataDescriptorBuilder withReturnType(MetadataResult<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 OutputMetadataDescriptorBuilder withAttributesType(MetadataResult<TypeMetadataDescriptor> attributesTypeResult)

Adds a MetadataResult of TypeMetadataDescriptor that describes the he output MuleMessage.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 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 OutputMetadataDescriptorBuilder withAttributesType(org.mule.metadata.api.model.MetadataType attributesType)

Describes that the output MuleMessage.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 MetadataAware component

Throws:

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