org.mule.runtime.api.message

Interface Message.CollectionBuilder

All Superinterfaces:

Message.Builder, Message.PayloadBuilder

Enclosing interface:

Message

public static interface Message.CollectionBuilder
extends Message.Builder

Method Summary

Modifier and Type	Method and Description
Message.CollectionBuilder	attributes(TypedValue<?> typedValue) Sets the Message's TypedValue attributes to be built, including their value and media type.
Message.CollectionBuilder	attributesMediaType(MediaType mediaType) Sets the MediaType for the Message attributes to be built.
Message.CollectionBuilder	attributesValue(Object value) Populates the builder from the given value.
Message.CollectionBuilder	itemMediaType(MediaType mediaType) Sets the MediaType for the collection items in the Message to be built.
Message.CollectionBuilder	mediaType(MediaType mediaType) Sets the MediaType for the Message payload to be built.
Message.CollectionBuilder	nullAttributesValue() Sets a #null value for the Message's attributes to be built.

Methods inherited from interface org.mule.runtime.api.message.Message.Builder

build

Methods inherited from interface org.mule.runtime.api.message.Message.PayloadBuilder

collectionValue, collectionValue, nullValue, payload, streamValue, value

Method Detail

itemMediaType

Message.CollectionBuilder itemMediaType(MediaType mediaType)

Sets the MediaType for the collection items in the Message to be built. See CollectionDataType.getItemDataType()

Parameters:

mediaType - the mediaType to set

Returns:

this builder

Throws:

NullPointerException - if the mediaType is null

mediaType

Message.CollectionBuilder mediaType(MediaType mediaType)

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

Specified by:

mediaType in interface Message.Builder

Parameters:

mediaType - the mediaType to set

Returns:

this builder

attributes

Message.CollectionBuilder attributes(TypedValue<?> typedValue)

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

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

Specified by:

attributes in interface Message.Builder

Parameters:

typedValue - the attributes desired

Returns:

this builder.

nullAttributesValue

Message.CollectionBuilder nullAttributesValue()

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

Specified by:

nullAttributesValue in interface Message.Builder

Returns:

this builder

attributesValue

Message.CollectionBuilder attributesValue(Object value)

Populates the builder from the given value.

This method will get the type, mimeType and encoding from the given value according to its concrete type.

Specified by:

attributesValue in interface Message.Builder

Parameters:

value - an object instance.

Returns:

this builder.

attributesMediaType

Message.CollectionBuilder attributesMediaType(MediaType mediaType)

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

Specified by:

attributesMediaType in interface Message.Builder

Parameters:

mediaType - the mediaType to set

Returns:

this builder