MutableMessageBuilder (Spring Integration API)

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

```
public final class MutableMessageBuilder<T>
extends AbstractIntegrationMessageBuilder<T>
```
コンポーネント内で使用できる特殊なメッセージビルダーで、そのコンポーネント内の変更に対して複数のメッセージを作成する必要があるというオーバーヘッドを回避します。
IMPORTANT: 可変メッセージは状態（メッセージヘッダーなど）を共有する場合があります。このようなメッセージを他のコンポーネントに公開しないでください。公開すると、望ましくない副作用が発生する可能性があります。
コンポーネント間で転送されるメッセージは、使用に細心の注意を払わない限り、常に不変であることが一般的に推奨されます。
導入:
4.0
作成者:
Gary Russell, Artem Bilan

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`Message<T>`	`build()`
`AbstractIntegrationMessageBuilder<T>`	`copyHeaders(MapSE<StringSE,?> headersToCopy)` 提供されたマップから名前と値のペアをコピーします。
`AbstractIntegrationMessageBuilder<T>`	`copyHeadersIfAbsent(MapSE<StringSE,?> headersToCopy)` 提供されたマップから名前と値のペアをコピーします。
`static <T> MutableMessageBuilder<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()`
`AbstractIntegrationMessageBuilder<T>`	`removeHeader(StringSE headerName)` 指定されたヘッダー名の値を削除します。
`AbstractIntegrationMessageBuilder<T>`	`removeHeaders(StringSE... headerPatterns)` 'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。
`AbstractIntegrationMessageBuilder<T>`	`setHeader(StringSE headerName, ObjectSE headerValue)` 指定されたヘッダー名の値を設定します。
`AbstractIntegrationMessageBuilder<T>`	`setHeaderIfAbsent(StringSE headerName, ObjectSE headerValue)` ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。
`static <T> MutableMessageBuilder<T>`	`withPayload(T payload)` 提供されたペイロードを使用して、新しい `Message` インスタンスのビルダーを作成します。
`static <T> MutableMessageBuilder<T>`	`withPayload(T payload, boolean generateHeaders)` 提供されたペイロードを使用して、新しい `Message` インスタンスのビルダーを作成します。

クラス org.springframework.integration.support.AbstractIntegrationMessageBuilder から継承されたメソッド
filterAndCopyHeadersIfAbsent, popSequenceDetails, pushSequenceDetails, setCorrelationId, setErrorChannel, setErrorChannelName, setExpirationDate, setExpirationDate, setPriority, setReplyChannel, setReplyChannelName, setSequenceNumber, setSequenceSize

クラス 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
  - withPayload
```
public static <T> MutableMessageBuilder<T> withPayload(T payload)
```
    提供されたペイロードを使用して、新しい Message インスタンスのビルダーを作成します。
    型パラメーター:
    T - ペイロードの型。
    パラメーター:
    payload - 新しいメッセージのペイロード
    戻り値:
    MutableMessageBuilder。
  - withPayload
```
public static <T> MutableMessageBuilder<T> withPayload(T payload,
                                                       boolean generateHeaders)
```
    提供されたペイロードを使用して、新しい Message インスタンスのビルダーを作成します。generateHeaders フラグを使用すると、MessageHeaders.ID および MessageHeaders.TIMESTAMP ヘッダーの生成を無効にできます。
    型パラメーター:
    T - ペイロードの型。
    パラメーター:
    payload - 新しいメッセージのペイロード
    generateHeaders - MessageHeaders.ID および MessageHeaders.TIMESTAMP ヘッダーを生成するかどうか
    戻り値:
    MutableMessageBuilder。
    導入:
    5.0
  - fromMessage
```
public static <T> MutableMessageBuilder<T> fromMessage(Message<T> message)
```
    指定されたメッセージからコピーされたすべてのヘッダーが事前に入力された新しい Message インスタンスのビルダーを作成します。提供されたメッセージのペイロードは、新しいメッセージのペイロードとしても使用されます。
    型パラメーター:
    T - ペイロードの型。
    パラメーター:
    message - ペイロードとすべてのヘッダーのコピー元のメッセージ
    戻り値:
    MutableMessageBuilder。
  - setHeader
```
public AbstractIntegrationMessageBuilder<T> setHeader(StringSE headerName,
                                                      @Nullable
                                                      ObjectSE headerValue)
```
    クラスからコピーされた説明: AbstractIntegrationMessageBuilder
    指定されたヘッダー名の値を設定します。指定された値が null の場合、ヘッダーは削除されます。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の setHeader
    パラメーター:
    headerName - ヘッダー名。
    headerValue - ヘッダー値。
    戻り値:
    this。
  - setHeaderIfAbsent
```
public AbstractIntegrationMessageBuilder<T> setHeaderIfAbsent(StringSE headerName,
                                                              ObjectSE headerValue)
```
    クラスからコピーされた説明: AbstractIntegrationMessageBuilder
    ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の setHeaderIfAbsent
    パラメーター:
    headerName - ヘッダー名。
    headerValue - ヘッダー値。
    戻り値:
    this。
  - removeHeaders
```
public AbstractIntegrationMessageBuilder<T> removeHeaders(StringSE... headerPatterns)
```
    クラスからコピーされた説明: AbstractIntegrationMessageBuilder
    'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。名前が示すように、配列にはヘッダー名の単純な一致パターンが含まれている場合があります。サポートされているパターンスタイルは、"xxx*"、"*xxx"、"*xxx*"、"xxx*yyy" です。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の removeHeaders
    パラメーター:
    headerPatterns - ヘッダーパターン。
    戻り値:
    this。
  - removeHeader
```
public AbstractIntegrationMessageBuilder<T> removeHeader(StringSE headerName)
```
    クラスからコピーされた説明: AbstractIntegrationMessageBuilder
    指定されたヘッダー名の値を削除します。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の removeHeader
    パラメーター:
    headerName - ヘッダー名。
    戻り値:
    this。
  - copyHeaders
```
public AbstractIntegrationMessageBuilder<T> copyHeaders(@Nullable
                                                        MapSE<StringSE,?> headersToCopy)
```
    クラスからコピーされた説明: AbstractIntegrationMessageBuilder
    提供されたマップから名前と値のペアをコピーします。この操作は既存の値を上書きします。値の上書きを回避するには、{AbstractIntegrationMessageBuilder.copyHeadersIfAbsent(Map) を使用します。"id" および "timestamp" ヘッダー値は決して上書きされないことに注意してください。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の copyHeaders
    パラメーター:
    headersToCopy - コピーするヘッダー。
    戻り値:
    this。
    関連事項:
    MessageHeaders.ID, MessageHeaders.TIMESTAMP
  - copyHeadersIfAbsent
```
public AbstractIntegrationMessageBuilder<T> copyHeadersIfAbsent(@Nullable
                                                                MapSE<StringSE,?> headersToCopy)
```
    クラスからコピーされた説明: AbstractIntegrationMessageBuilder
    提供されたマップから名前と値のペアをコピーします。この操作では、既存の値は上書きされません。
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の copyHeadersIfAbsent
    パラメーター:
    headersToCopy - コピーするヘッダー。
    戻り値:
    this。
  - getSequenceDetails
```
protected ListSE<ListSE<ObjectSE>> getSequenceDetails()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getSequenceDetails
  - getCorrelationId
```
protected ObjectSE getCorrelationId()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getCorrelationId
  - getSequenceNumber
```
protected ObjectSE getSequenceNumber()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getSequenceNumber
  - getSequenceSize
```
protected ObjectSE getSequenceSize()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の getSequenceSize
  - build
```
public Message<T> build()
```
    次で指定:
    クラス AbstractIntegrationMessageBuilder<T> の build

クラス MutableMessageBuilder<T>

方法の概要

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

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

メソッドの詳細

getPayload

getHeaders

getHeader

withPayload

withPayload

fromMessage

setHeader

setHeaderIfAbsent

removeHeaders

removeHeader

copyHeaders

copyHeadersIfAbsent

getSequenceDetails

getCorrelationId

getSequenceNumber

getSequenceSize

build