org.mule.runtime.api.message

Interface Message.Builder

All Superinterfaces:

Message.PayloadBuilder

All Known Subinterfaces:

Message.CollectionBuilder

Enclosing interface:

Message

public static interface Message.Builder
extends Message.PayloadBuilder

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

See Also:

#attributes(TypedValue)}, {@link #attributesValue(Object)}, {@link #attributesMediaType(MediaType)}

Method Summary

Modifier and Type	Method and Description
Message.Builder	attributes(TypedValue<?> typedValue) Sets the Message's TypedValue attributes to be built, including their value and media type.
Message.Builder	attributesMediaType(MediaType mediaType) Sets the MediaType for the Message attributes to be built.
Message.Builder	attributesValue(Object value) Populates the builder from the given value.
Message	build() Builds a new Message with the values set in this builder.
Message.Builder	mediaType(MediaType mediaType) Sets the MediaType for the Message payload to be built.
Message.Builder	nullAttributesValue() Sets a #null value for the Message's attributes to be built.

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

collectionValue, collectionValue, nullValue, payload, streamValue, value

Method Detail

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

attributes

Message.Builder 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 attributesValue(Object), attributesMediaType(MediaType).

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

Parameters:

typedValue - the attributes desired

Returns:

this builder.

Throws:

NullPointerException - if the value is null

nullAttributesValue

Message.Builder nullAttributesValue()

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

Returns:

this builder

attributesValue

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

Parameters:

value - an object instance.

Returns:

this builder.

Throws:

NullPointerException - if the value is null

attributesMediaType

Message.Builder attributesMediaType(MediaType mediaType)

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

Parameters:

mediaType - the mediaType to set

Returns:

this builder

Throws:

NullPointerException - if the mediaType is null

build

Message build()

Builds a new Message with the values set in this builder.

Returns:

a newly built Message.