org.springframework.integration.message
Class MessageBuilder<T>

java.lang.Object
  org.springframework.integration.message.MessageBuilder<T>

public final class MessageBuilder<T>
extends java.lang.Object

Author:

Arjen Poutsma, Mark Fisher

Field Summary

private java.util.Map<java.lang.String,java.lang.Object>	headers
private T	payload

Constructor Summary

private

MessageBuilder(T payload) Private constructor to be invoked from the static factory methods only.

Method Summary

Message<T>	build()
MessageBuilder<T>	copyHeaders(java.util.Map<java.lang.String,java.lang.Object> headersToCopy) Copy the name-value pairs from the provided Map.
MessageBuilder<T>	copyHeadersIfAbsent(java.util.Map<java.lang.String,java.lang.Object> headersToCopy) Copy the name-value pairs from the provided Map.
static <T> MessageBuilder<T>	fromMessage(Message<T> message) Create a builder for a new Message instance pre-populated with all of the headers copied from the provided message.
static <T> MessageBuilder<T>	fromPayload(T payload) Create a builder for a new Message instance with the provided payload.
private boolean	isEligibleForCopying(java.lang.String key)
MessageBuilder<T>	setCorrelationId(java.lang.Object correlationId)
MessageBuilder<T>	setExpirationDate(java.util.Date expirationDate)
MessageBuilder<T>	setHeader(java.lang.String headerName, java.lang.Object headerValue) Set the value for the given header name.
MessageBuilder<T>	setHeaderIfAbsent(java.lang.String headerName, java.lang.Object headerValue) Set the value for the given header name only if the header name is not already associated with a value.
MessageBuilder<T>	setNextTarget(MessageTarget nextTarget)
MessageBuilder<T>	setNextTarget(java.lang.String nextTarget)
MessageBuilder<T>	setPriority(MessagePriority priority)
MessageBuilder<T>	setReturnAddress(MessageTarget returnAddress)
MessageBuilder<T>	setReturnAddress(java.lang.String returnAddress)
MessageBuilder<T>	setSequenceNumber(java.lang.Integer sequenceNumber)
MessageBuilder<T>	setSequenceSize(java.lang.Integer sequenceSize)

Methods inherited from class java.lang.Object

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

Field Detail

payload

private final T payload

headers

private final java.util.Map<java.lang.String,java.lang.Object> headers

Constructor Detail

MessageBuilder

private MessageBuilder(T payload)

Private constructor to be invoked from the static factory methods only.

Method Detail

fromMessage

public static <T> MessageBuilder<T> fromMessage(Message<T> message)

Create a builder for a new Message instance pre-populated with all of the headers copied from the provided message. The payload will also be taken from the provided message.

Parameters:

messageToCopy - the Message from which the paylaod and all headers will be copied

fromPayload

public static <T> MessageBuilder<T> fromPayload(T payload)

Create a builder for a new Message instance with the provided payload.

Parameters:

payload - the payload for the new message

setHeader

public MessageBuilder<T> setHeader(java.lang.String headerName,
                                   java.lang.Object headerValue)

Set the value for the given header name. If the provided value is null, the header will be removed.

setHeaderIfAbsent

public MessageBuilder<T> setHeaderIfAbsent(java.lang.String headerName,
                                           java.lang.Object headerValue)

Set the value for the given header name only if the header name is not already associated with a value.

copyHeaders

public MessageBuilder<T> copyHeaders(java.util.Map<java.lang.String,java.lang.Object> headersToCopy)

Copy the name-value pairs from the provided Map. This operation will overwrite any existing values. Use {copyHeadersIfAbsent(Map) to avoid overwriting values. Note that the 'id' and 'timestamp' header values will never be overwritten.

See Also:

MessageHeaders.ID, MessageHeaders.TIMESTAMP

copyHeadersIfAbsent

public MessageBuilder<T> copyHeadersIfAbsent(java.util.Map<java.lang.String,java.lang.Object> headersToCopy)

Copy the name-value pairs from the provided Map. This operation will not overwrite any existing values.

setExpirationDate

public MessageBuilder<T> setExpirationDate(java.util.Date expirationDate)

setCorrelationId

public MessageBuilder<T> setCorrelationId(java.lang.Object correlationId)

setNextTarget

public MessageBuilder<T> setNextTarget(MessageTarget nextTarget)

setNextTarget

public MessageBuilder<T> setNextTarget(java.lang.String nextTarget)

setReturnAddress

public MessageBuilder<T> setReturnAddress(MessageTarget returnAddress)

setReturnAddress

public MessageBuilder<T> setReturnAddress(java.lang.String returnAddress)

setSequenceNumber

public MessageBuilder<T> setSequenceNumber(java.lang.Integer sequenceNumber)

setSequenceSize

public MessageBuilder<T> setSequenceSize(java.lang.Integer sequenceSize)

setPriority

public MessageBuilder<T> setPriority(MessagePriority priority)

build

public Message<T> build()

isEligibleForCopying

private boolean isEligibleForCopying(java.lang.String key)