MessageBuilder (Spring Integration API)

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

```
public final class MessageBuilder<T>
extends AbstractIntegrationMessageBuilder<T>
```
デフォルトのメッセージビルダー。不変の GenericMessage を作成します。下位互換性のために、DefaultMessageBuilder ではなく MessageBuilder という名前が付けられています。
作成者:
Arjen Poutsma, Mark Fisher, Oleg Zhurakousky, Dave Syer, Gary Russell, Artem Bilan

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`Message<T>`	`build()`
`MessageBuilder<T>`	`copyHeaders(MapSE<StringSE,?> headersToCopy)` 提供されたマップから名前と値のペアをコピーします。
`MessageBuilder<T>`	`copyHeadersIfAbsent(MapSE<StringSE,?> headersToCopy)` 提供されたマップから名前と値のペアをコピーします。
`static <T> MessageBuilder<T>`	`fromMessage(Message<T> message)` 提供されたメッセージからコピーされたすべてのヘッダーが事前入力された新しい `Message` インスタンス用のビルダーを作成します。
`protected ObjectSE`	`getCorrelationId()`
`<V> V`	`getHeader(StringSE key, ClassSE<V> type)`
`MapSE<StringSE, ObjectSE>`	`getHeaders()`
`T`	`getPayload()`
`protected ListSE<ListSE<ObjectSE>>`	`getSequenceDetails()`
`protected ObjectSE`	`getSequenceNumber()`
`protected ObjectSE`	`getSequenceSize()`
`MessageBuilder<T>`	`popSequenceDetails()`
`MessageBuilder<T>`	`pushSequenceDetails(ObjectSE correlationId, int sequenceNumber, int sequenceSize)`
`MessageBuilder<T>`	`readOnlyHeaders(StringSE... readOnlyHeaders)` 読み取り専用と見なし、メッセージへの入力を禁止するヘッダーのリストを指定します。
`MessageBuilder<T>`	`removeHeader(StringSE headerName)` 指定されたヘッダー名の値を削除します。
`MessageBuilder<T>`	`removeHeaders(StringSE... headerPatterns)` 'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。
`MessageBuilder<T>`	`setCorrelationId(ObjectSE correlationId)`
`MessageBuilder<T>`	`setErrorChannel(MessageChannel errorChannel)`
`MessageBuilder<T>`	`setErrorChannelName(StringSE errorChannelName)`
`MessageBuilder<T>`	`setExpirationDate(DateSE expirationDate)`
`MessageBuilder<T>`	`setExpirationDate(LongSE expirationDate)`
`MessageBuilder<T>`	`setHeader(StringSE headerName, ObjectSE headerValue)` 指定されたヘッダー名の値を設定します。
`MessageBuilder<T>`	`setHeaderIfAbsent(StringSE headerName, ObjectSE headerValue)` ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。
`MessageBuilder<T>`	`setPriority(IntegerSE priority)`
`MessageBuilder<T>`	`setReplyChannel(MessageChannel replyChannel)`
`MessageBuilder<T>`	`setReplyChannelName(StringSE replyChannelName)`
`MessageBuilder<T>`	`setSequenceNumber(IntegerSE sequenceNumber)`
`MessageBuilder<T>`	`setSequenceSize(IntegerSE sequenceSize)`
`static <T> MessageBuilder<T>`	`withPayload(T payload)` 提供されたペイロードを使用して、新しい `Message` インスタンスのビルダーを作成します。

クラス org.springframework.integration.support.AbstractIntegrationMessageBuilder から継承されたメソッド
filterAndCopyHeadersIfAbsent

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- メソッドの詳細
  - getPayload
```
public T getPayload()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getPayload
  - getHeaders
```
public MapSE<StringSE,ObjectSE> getHeaders()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getHeaders
  - getHeader
```
@Nullable
public <V> V getHeader(StringSE key,
                                 ClassSE<V> type)
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getHeader
  - fromMessage
```
public static <T> MessageBuilder<T> fromMessage(Message<T> message)
```
    指定されたメッセージからコピーされたすべてのヘッダーが事前に入力された新しい Message インスタンスのビルダーを作成します。提供されたメッセージのペイロードは、新しいメッセージのペイロードとしても使用されます。
    型パラメーター:
    T - ペイロードの型。
    パラメーター:
    message - ペイロードとすべてのヘッダーのコピー元のメッセージ
    戻り値:
    MessageBuilder。
  - withPayload
```
public static <T> MessageBuilder<T> withPayload(T payload)
```
    提供されたペイロードを使用して、新しい Message インスタンスのビルダーを作成します。
    型パラメーター:
    T - ペイロードの型。
    パラメーター:
    payload - 新しいメッセージのペイロード
    戻り値:
    MessageBuilder。
  - setHeader
```
public MessageBuilder<T> setHeader(StringSE headerName,
                                   @Nullable
                                   ObjectSE headerValue)
```
    指定されたヘッダー名の値を設定します。指定された値が null の場合、ヘッダーは削除されます。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の setHeader
    パラメーター:
    headerName - ヘッダー名。
    headerValue - ヘッダー値。
    戻り値:
    この MessageBuilder。
  - setHeaderIfAbsent
```
public MessageBuilder<T> setHeaderIfAbsent(StringSE headerName,
                                           ObjectSE headerValue)
```
    ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の setHeaderIfAbsent
    パラメーター:
    headerName - ヘッダー名。
    headerValue - ヘッダー値。
    戻り値:
    この MessageBuilder。
  - removeHeaders
```
public MessageBuilder<T> removeHeaders(StringSE... headerPatterns)
```
    'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。名前が示すように、配列にはヘッダー名の単純な一致パターンが含まれている場合があります。サポートされているパターンスタイルは、"xxx*"、"*xxx"、"*xxx*"、"xxx*yyy" です。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の removeHeaders
    パラメーター:
    headerPatterns - ヘッダーパターン。
    戻り値:
    この MessageBuilder。
  - removeHeader
```
public MessageBuilder<T> removeHeader(StringSE headerName)
```
    指定されたヘッダー名の値を削除します。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の removeHeader
    パラメーター:
    headerName - ヘッダー名。
    戻り値:
    この MessageBuilder。
  - copyHeaders
```
public MessageBuilder<T> copyHeaders(@Nullable
                                     MapSE<StringSE,?> headersToCopy)
```
    提供されたマップから名前と値のペアをコピーします。この操作は既存の値を上書きします。値の上書きを回避するには、{copyHeadersIfAbsent(Map) を使用します。"id" および "timestamp" ヘッダー値は決して上書きされないことに注意してください。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の copyHeaders
    パラメーター:
    headersToCopy - コピーするヘッダー。
    戻り値:
    この MessageBuilder。
    関連事項:
    MessageHeaders.ID, MessageHeaders.TIMESTAMP
  - copyHeadersIfAbsent
```
public MessageBuilder<T> copyHeadersIfAbsent(@Nullable
                                             MapSE<StringSE,?> headersToCopy)
```
    提供されたマップから名前と値のペアをコピーします。この操作では、既存の値は上書きされません。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の copyHeadersIfAbsent
    パラメーター:
    headersToCopy - コピーするヘッダー。
    戻り値:
    この MessageBuilder。
  - getSequenceDetails
```
@Nullable
protected ListSE<ListSE<ObjectSE>> getSequenceDetails()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getSequenceDetails
  - getCorrelationId
```
@Nullable
protected ObjectSE getCorrelationId()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getCorrelationId
  - getSequenceNumber
```
protected ObjectSE getSequenceNumber()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getSequenceNumber
  - getSequenceSize
```
protected ObjectSE getSequenceSize()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getSequenceSize
  - pushSequenceDetails
```
public MessageBuilder<T> pushSequenceDetails(ObjectSE correlationId,
                                             int sequenceNumber,
                                             int sequenceSize)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の pushSequenceDetails
  - popSequenceDetails
```
public MessageBuilder<T> popSequenceDetails()
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の popSequenceDetails
  - setExpirationDate
```
public MessageBuilder<T> setExpirationDate(LongSE expirationDate)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setExpirationDate
  - setExpirationDate
```
public MessageBuilder<T> setExpirationDate(DateSE expirationDate)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setExpirationDate
  - setCorrelationId
```
public MessageBuilder<T> setCorrelationId(ObjectSE correlationId)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setCorrelationId
  - setReplyChannel
```
public MessageBuilder<T> setReplyChannel(MessageChannel replyChannel)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setReplyChannel
  - setReplyChannelName
```
public MessageBuilder<T> setReplyChannelName(StringSE replyChannelName)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setReplyChannelName
  - setErrorChannel
```
public MessageBuilder<T> setErrorChannel(MessageChannel errorChannel)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setErrorChannel
  - setErrorChannelName
```
public MessageBuilder<T> setErrorChannelName(StringSE errorChannelName)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setErrorChannelName
  - setSequenceNumber
```
public MessageBuilder<T> setSequenceNumber(IntegerSE sequenceNumber)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setSequenceNumber
  - setSequenceSize
```
public MessageBuilder<T> setSequenceSize(IntegerSE sequenceSize)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setSequenceSize
  - setPriority
```
public MessageBuilder<T> setPriority(IntegerSE priority)
```
    オーバーライド:
    クラス AbstractIntegrationMessageBuilder<T> の setPriority
  - readOnlyHeaders
```
public MessageBuilder<T> readOnlyHeaders(StringSE... readOnlyHeaders)
```
    読み取り専用と見なし、メッセージへの入力を禁止するヘッダーのリストを指定します。
    パラメーター:
    readOnlyHeaders - readOnly モードのヘッダーのリスト。デフォルトは MessageHeaders.ID および MessageHeaders.TIMESTAMP です。
    戻り値:
    現在の MessageBuilder
    導入:
    4.3.2
    関連事項:
    IntegrationMessageHeaderAccessor.isReadOnly(String)
  - build
```
public Message<T> build()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の build

クラス MessageBuilder<T>

メソッドのサマリー

クラス org.springframework.integration.support.AbstractIntegrationMessageBuilder から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

メソッドの詳細

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