org.mule.runtime.api.message

Interface Message.PayloadBuilder

All Known Subinterfaces:

Message.Builder, Message.CollectionBuilder, Message.MapBuilder

Enclosing interface:

Message

public static interface Message.PayloadBuilder

Handles the Message's payload creation, either from a provided TypedValue or constructing it internally from a given value and MediaType.

See Also:

PayloadBuilder#payload(TypedValue)}, {@link PayloadBuilder#value(Object)}, {@link Builder#mediaType(MediaType)}

Method Summary

Modifier and Type	Method and Description
Message.CollectionBuilder	collectionValue(Collection value, Class<?> itemType) Sets the collection value for the Message's payload to be built.
Message.CollectionBuilder	collectionValue(Object[] value) Sets the collection value for the Message's payload to be built.
default Message.MapBuilder	mapValue(Map value, Class<?> keyType, Class<?> valueType) Sets the map value for the Message's payload to be built.
Message.Builder	nullValue() Sets a #null value for the Message's payload to be built.
Message.Builder	payload(TypedValue<?> typedValue) Sets the Message's TypedValue payload to be built, including it's value and media type.
Message.CollectionBuilder	streamValue(Iterator value, Class<?> itemType) Sets the consumable streaming collection value for the Message's payload to be built.
Message.Builder	value(Object value) Sets the value for the Message's payload to be built.

Method Detail

payload

Message.Builder payload(TypedValue<?> typedValue)

Sets the Message's TypedValue payload to be built, including it's value and media type. This should be used when you already have a TypedValue. Alternatively, a Message can be constructed from just the value or value and mediaType component parts and the builder will generate the TypedValue. See value(Object), Message.Builder.mediaType(MediaType).

If a mediaType or value have been previously set then they will be overwritten.

Parameters:

typedValue - the message payload

Returns:

this builder.

nullValue

Message.Builder nullValue()

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

Returns:

this builder

value

Message.Builder value(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.

streamValue

Message.CollectionBuilder streamValue(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 collectionValue(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

collectionValue

Message.CollectionBuilder collectionValue(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

collectionValue

Message.CollectionBuilder collectionValue(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

mapValue

default Message.MapBuilder mapValue(Map value,
                                    Class<?> keyType,
                                    Class<?> valueType)

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

Parameters:

value - the map content

keyType - the map's key type

valueType - the map's value type

Returns:

this builder

Throws:

NullPointerException - if the content is null