MessageBuilder (Spring Integration 5.4.0 API)

java.lang.Object
- org.springframework.integration.support.AbstractIntegrationMessageBuilder<T>
- - org.springframework.integration.support.MessageBuilder<T>

```
public final class MessageBuilder<T>
extends AbstractIntegrationMessageBuilder<T>
```
The default message builder; creates immutable GenericMessages. Named MessageBuilder instead of DefaultMessageBuilder for backwards compatibility.

Author:

Arjen Poutsma, Mark Fisher, Oleg Zhurakousky, Dave Syer, Gary Russell, Artem Bilan

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message<T>`	`build()`
`MessageBuilder<T>`	`copyHeaders(Map<String,?> headersToCopy)` Copy the name-value pairs from the provided Map.
`MessageBuilder<T>`	`copyHeadersIfAbsent(Map<String,?> 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.
`protected Object`	`getCorrelationId()`
`<V> V`	`getHeader(String key, Class<V> type)`
`Map<String,Object>`	`getHeaders()`
`T`	`getPayload()`
`protected List<List<Object>>`	`getSequenceDetails()`
`protected Object`	`getSequenceNumber()`
`protected Object`	`getSequenceSize()`
`MessageBuilder<T>`	`popSequenceDetails()`
`MessageBuilder<T>`	`pushSequenceDetails(Object correlationId, int sequenceNumber, int sequenceSize)`
`MessageBuilder<T>`	`readOnlyHeaders(String... readOnlyHeaders)` Specify a list of headers which should be considered as read only and prohibited from being populated in the message.
`MessageBuilder<T>`	`removeHeader(String headerName)` Remove the value for the given header name.
`MessageBuilder<T>`	`removeHeaders(String... headerPatterns)` Removes all headers provided via array of 'headerPatterns'.
`MessageBuilder<T>`	`setCorrelationId(Object correlationId)`
`MessageBuilder<T>`	`setErrorChannel(MessageChannel errorChannel)`
`MessageBuilder<T>`	`setErrorChannelName(String errorChannelName)`
`MessageBuilder<T>`	`setExpirationDate(Date expirationDate)`
`MessageBuilder<T>`	`setExpirationDate(Long expirationDate)`
`MessageBuilder<T>`	`setHeader(String headerName, Object headerValue)` Set the value for the given header name.
`MessageBuilder<T>`	`setHeaderIfAbsent(String headerName, Object headerValue)` Set the value for the given header name only if the header name is not already associated with a value.
`MessageBuilder<T>`	`setPriority(Integer priority)`
`MessageBuilder<T>`	`setReplyChannel(MessageChannel replyChannel)`
`MessageBuilder<T>`	`setReplyChannelName(String replyChannelName)`
`MessageBuilder<T>`	`setSequenceNumber(Integer sequenceNumber)`
`MessageBuilder<T>`	`setSequenceSize(Integer sequenceSize)`
`static <T> MessageBuilder<T>`	`withPayload(T payload)` Create a builder for a new `Message` instance with the provided payload.

Methods inherited from class org.springframework.integration.support.AbstractIntegrationMessageBuilder
filterAndCopyHeadersIfAbsent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getPayload
```
public T getPayload()
```
    Specified by:
    
    getPayload in class AbstractIntegrationMessageBuilder<T>
  - getHeaders
```
public Map<String,Object> getHeaders()
```
    Specified by:
    
    getHeaders in class AbstractIntegrationMessageBuilder<T>
  - getHeader
```
@Nullable
public <V> V getHeader(String key,
                                 Class<V> type)
```
    Specified by:
    
    getHeader in class AbstractIntegrationMessageBuilder<T>
  - 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 of the provided Message will also be used as the payload for the new message.
    
    Type Parameters:
    
    T - The type of the payload.
    
    Parameters:
    
    message - the Message from which the payload and all headers will be copied
    
    Returns:
    
    A MessageBuilder.
  - withPayload
```
public static <T> MessageBuilder<T> withPayload(T payload)
```
    Create a builder for a new Message instance with the provided payload.
    
    Type Parameters:
    
    T - The type of the payload.
    
    Parameters:
    
    payload - the payload for the new message
    
    Returns:
    
    A MessageBuilder.
  - setHeader
```
public MessageBuilder<T> setHeader(String headerName,
                                   @Nullable
                                   Object headerValue)
```
    Set the value for the given header name. If the provided value is null, the header will be removed.
    
    Specified by:
    
    setHeader in class AbstractIntegrationMessageBuilder<T>
    
    Parameters:
    
    headerName - The header name.
    
    headerValue - The header value.
    
    Returns:
    
    this MessageBuilder.
  - setHeaderIfAbsent
```
public MessageBuilder<T> setHeaderIfAbsent(String headerName,
                                           Object headerValue)
```
    Set the value for the given header name only if the header name is not already associated with a value.
    
    Specified by:
    
    setHeaderIfAbsent in class AbstractIntegrationMessageBuilder<T>
    
    Parameters:
    
    headerName - The header name.
    
    headerValue - The header value.
    
    Returns:
    
    this MessageBuilder.
  - removeHeaders
```
public MessageBuilder<T> removeHeaders(String... headerPatterns)
```
    Removes all headers provided via array of 'headerPatterns'. As the name suggests the array may contain simple matching patterns for header names. Supported pattern styles are: "xxx*", "*xxx", "*xxx*" and "xxx*yyy".
    
    Specified by:
    
    removeHeaders in class AbstractIntegrationMessageBuilder<T>
    
    Parameters:
    
    headerPatterns - The header patterns.
    
    Returns:
    
    this MessageBuilder.
  - removeHeader
```
public MessageBuilder<T> removeHeader(String headerName)
```
    Remove the value for the given header name.
    
    Specified by:
    
    removeHeader in class AbstractIntegrationMessageBuilder<T>
    
    Parameters:
    
    headerName - The header name.
    
    Returns:
    
    this MessageBuilder.
  - copyHeaders
```
public MessageBuilder<T> copyHeaders(@Nullable
                                     Map<String,?> 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.
    
    Specified by:
    
    copyHeaders in class AbstractIntegrationMessageBuilder<T>
    
    Parameters:
    
    headersToCopy - The headers to copy.
    
    Returns:
    
    this MessageBuilder.
    
    See Also:
    
    MessageHeaders.ID, MessageHeaders.TIMESTAMP
  - copyHeadersIfAbsent
```
public MessageBuilder<T> copyHeadersIfAbsent(@Nullable
                                             Map<String,?> headersToCopy)
```
    Copy the name-value pairs from the provided Map. This operation will not overwrite any existing values.
    
    Specified by:
    
    copyHeadersIfAbsent in class AbstractIntegrationMessageBuilder<T>
    
    Parameters:
    
    headersToCopy - The headers to copy.
    
    Returns:
    
    this MessageBuilder.
  - getSequenceDetails
```
@Nullable
protected List<List<Object>> getSequenceDetails()
```
    Specified by:
    
    getSequenceDetails in class AbstractIntegrationMessageBuilder<T>
  - getCorrelationId
```
@Nullable
protected Object getCorrelationId()
```
    Specified by:
    
    getCorrelationId in class AbstractIntegrationMessageBuilder<T>
  - getSequenceNumber
```
protected Object getSequenceNumber()
```
    Specified by:
    
    getSequenceNumber in class AbstractIntegrationMessageBuilder<T>
  - getSequenceSize
```
protected Object getSequenceSize()
```
    Specified by:
    
    getSequenceSize in class AbstractIntegrationMessageBuilder<T>
  - pushSequenceDetails
```
public MessageBuilder<T> pushSequenceDetails(Object correlationId,
                                             int sequenceNumber,
                                             int sequenceSize)
```
    Overrides:
    
    pushSequenceDetails in class AbstractIntegrationMessageBuilder<T>
  - popSequenceDetails
```
public MessageBuilder<T> popSequenceDetails()
```
    Overrides:
    
    popSequenceDetails in class AbstractIntegrationMessageBuilder<T>
  - setExpirationDate
```
public MessageBuilder<T> setExpirationDate(Long expirationDate)
```
    Overrides:
    
    setExpirationDate in class AbstractIntegrationMessageBuilder<T>
  - setExpirationDate
```
public MessageBuilder<T> setExpirationDate(Date expirationDate)
```
    Overrides:
    
    setExpirationDate in class AbstractIntegrationMessageBuilder<T>
  - setCorrelationId
```
public MessageBuilder<T> setCorrelationId(Object correlationId)
```
    Overrides:
    
    setCorrelationId in class AbstractIntegrationMessageBuilder<T>
  - setReplyChannel
```
public MessageBuilder<T> setReplyChannel(MessageChannel replyChannel)
```
    Overrides:
    
    setReplyChannel in class AbstractIntegrationMessageBuilder<T>
  - setReplyChannelName
```
public MessageBuilder<T> setReplyChannelName(String replyChannelName)
```
    Overrides:
    
    setReplyChannelName in class AbstractIntegrationMessageBuilder<T>
  - setErrorChannel
```
public MessageBuilder<T> setErrorChannel(MessageChannel errorChannel)
```
    Overrides:
    
    setErrorChannel in class AbstractIntegrationMessageBuilder<T>
  - setErrorChannelName
```
public MessageBuilder<T> setErrorChannelName(String errorChannelName)
```
    Overrides:
    
    setErrorChannelName in class AbstractIntegrationMessageBuilder<T>
  - setSequenceNumber
```
public MessageBuilder<T> setSequenceNumber(Integer sequenceNumber)
```
    Overrides:
    
    setSequenceNumber in class AbstractIntegrationMessageBuilder<T>
  - setSequenceSize
```
public MessageBuilder<T> setSequenceSize(Integer sequenceSize)
```
    Overrides:
    
    setSequenceSize in class AbstractIntegrationMessageBuilder<T>
  - setPriority
```
public MessageBuilder<T> setPriority(Integer priority)
```
    Overrides:
    
    setPriority in class AbstractIntegrationMessageBuilder<T>
  - readOnlyHeaders
```
public MessageBuilder<T> readOnlyHeaders(String... readOnlyHeaders)
```
    Specify a list of headers which should be considered as read only and prohibited from being populated in the message.
    
    Parameters:
    
    readOnlyHeaders - the list of headers for readOnly mode. Defaults to MessageHeaders.ID and MessageHeaders.TIMESTAMP.
    
    Returns:
    
    the current MessageBuilder
    
    Since:
    
    4.3.2
    
    See Also:
    
    IntegrationMessageHeaderAccessor.isReadOnly(String)
  - build
```
public Message<T> build()
```
    Specified by:
    
    build in class AbstractIntegrationMessageBuilder<T>

Class MessageBuilder<T>

Method Summary

Methods inherited from class org.springframework.integration.support.AbstractIntegrationMessageBuilder

Methods inherited from class java.lang.Object

Method Detail

getPayload

getHeaders

getHeader

fromMessage

withPayload

setHeader

setHeaderIfAbsent

removeHeaders

removeHeader

copyHeaders

copyHeadersIfAbsent

getSequenceDetails

getCorrelationId

getSequenceNumber

getSequenceSize

pushSequenceDetails

popSequenceDetails

setExpirationDate

setExpirationDate

setCorrelationId

setReplyChannel

setReplyChannelName

setErrorChannel

setErrorChannelName

setSequenceNumber

setSequenceSize

setPriority

readOnlyHeaders

build