org.mule.runtime.api.message

Interface Message.PayloadBuilder

All Known Subinterfaces:

Message.Builder, Message.CollectionBuilder

Enclosing interface:

Message

public static interface Message.PayloadBuilder

Method Summary

Modifier and Type	Method and Description
Message.Builder	collectionPayload(Collection value, Class<?> itemType) Sets the collection value for the Message's payload to be built.
Message.Builder	collectionPayload(Object[] value) Sets the collection value for the Message's payload to be built.
Message.Builder	mediaType(MediaType mediaType) Sets the MediaType for the Message payload to be built.
Message.Builder	nullPayload() Sets a #null value for the Message's payload to be built.
Message.Builder	payload(Object value) Sets the value for the Message's payload to be built.
Message.Builder	streamPayload(Iterator value, Class<?> itemType) Sets the consumable streaming collection value for the Message's payload to be built.

Method Detail

nullPayload

Message.Builder nullPayload()

Sets a #null value for the Message's payload to be built.

Returns:

this builder

payload

Message.Builder payload(Object value)

Sets the value for the Message's payload to be built.

If a DataType has previously been set it's type will be updated to reflect the type of the new content class while preserving it's MediaType, unless the new content type defines it's own MediaType in which case this will be used instead. See DataTypeBuilder.fromObject(Object)

Parameters:

value - the message content

Returns:

this builder.

mediaType

Message.Builder mediaType(MediaType mediaType)

Sets the MediaType for the Message payload to be built. See DataType.getMediaType()

Parameters:

mediaType - the mediaType to set

Returns:

this builder

Throws:

NullPointerException - if the mediaType is null

streamPayload

Message.Builder streamPayload(Iterator value,
                              Class<?> itemType)

Sets the consumable streaming collection value for the Message's payload to be built.

If a DataType has previously been set it's type will be updated to reflect the type of the new content class while preserving it's MediaType, unless the new value type defines it's own MediaType in which case this will be used instead. See DataTypeBuilder.fromObject(Object).

If you already have a Collection instance, use collectionPayload(Collection, Class) instead.

Parameters:

value - the iterator for the collection content

itemType - the collection item type

Returns:

this builder

Throws:

NullPointerException - if the payload is null

collectionPayload

Message.Builder collectionPayload(Collection value,
                                  Class<?> itemType)

Sets the collection value for the Message's payload to be built.

If a DataType has previously been set it's type will be updated to reflect the type of the new content class while preserving it's MediaType, unless the new value type defines it's own MediaType in which case this will be used instead. See DataTypeBuilder.fromObject(Object)

Parameters:

value - the collection content

itemType - the collection item type

Returns:

this builder

Throws:

NullPointerException - if the content is null

collectionPayload

Message.Builder collectionPayload(Object[] value)

Sets the collection value for the Message's payload to be built.

If a DataType has previously been set it's type will be updated to reflect the type of the new content class while preserving it's MediaType, unless the new value type defines it's own MediaType in which case this will be used instead. See DataTypeBuilder.fromObject(Object)

Parameters:

value - the array to use as a collection content

Returns:

this builder

Throws:

NullPointerException - if the content is null