MessageBuilder (Spring Framework API)

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

型パラメーター:
T - メッセージのペイロード型
```
public final class MessageBuilder<T>
extends ObjectSE
```
GenericMessage（またはペイロードの型が ThrowableSE の場合は ErrorMessage）を作成するためのビルダー。
導入:
4.0
作成者:
Arjen Poutsma, Mark Fisher, Rossen Stoyanchev
関連事項:
GenericMessage, ErrorMessage

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`Message<T>`	`build()`
`MessageBuilder<T>`	`copyHeaders(MapSE<StringSE,?> headersToCopy)` 提供されたマップから名前と値のペアをコピーします。
`MessageBuilder<T>`	`copyHeadersIfAbsent(MapSE<StringSE,?> headersToCopy)` 提供されたマップから名前と値のペアをコピーします。
`static <T> Message<T>`	`createMessage(T payload, MessageHeaders messageHeaders)` 指定されたペイロードと `MessageHeaders` を使用してメッセージを作成するためのショートカットファクトリメソッド。
`static <T> MessageBuilder<T>`	`fromMessage(Message<T> message)` 提供されたメッセージからコピーされたすべてのヘッダーが事前入力された新しい `Message` インスタンス用のビルダーを作成します。
`MessageBuilder<T>`	`removeHeader(StringSE headerName)` 指定されたヘッダー名の値を削除します。
`MessageBuilder<T>`	`removeHeaders(StringSE... headerPatterns)` 'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。
`MessageBuilder<T>`	`setErrorChannel(MessageChannel errorChannel)`
`MessageBuilder<T>`	`setErrorChannelName(StringSE errorChannelName)`
`MessageBuilder<T>`	`setHeader(StringSE headerName, ObjectSE headerValue)` 指定されたヘッダー名の値を設定します。
`MessageBuilder<T>`	`setHeaderIfAbsent(StringSE headerName, ObjectSE headerValue)` ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。
`MessageBuilder<T>`	`setHeaders(MessageHeaderAccessor accessor)` `MessageHeaderAccessor` を指定して、使用するメッセージヘッダーを設定します。
`MessageBuilder<T>`	`setReplyChannel(MessageChannel replyChannel)`
`MessageBuilder<T>`	`setReplyChannelName(StringSE replyChannelName)`
`static <T> MessageBuilder<T>`	`withPayload(T payload)` 指定されたペイロードでメッセージの新しいビルダーを作成します。

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

- メソッドの詳細
  - setHeaders
```
public MessageBuilder<T> setHeaders(MessageHeaderAccessor accessor)
```
    MessageHeaderAccessor を指定して、使用するメッセージヘッダーを設定します。
    パラメーター:
    accessor - 使用するヘッダー
  - setHeader
```
public MessageBuilder<T> setHeader(StringSE headerName,
                                   @Nullable
                                   ObjectSE headerValue)
```
    指定されたヘッダー名の値を設定します。指定された値が null の場合、ヘッダーは削除されます。
  - setHeaderIfAbsent
```
public MessageBuilder<T> setHeaderIfAbsent(StringSE headerName,
                                           ObjectSE headerValue)
```
    ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。
  - removeHeaders
```
public MessageBuilder<T> removeHeaders(StringSE... headerPatterns)
```
    'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。名前が示すように、配列にはヘッダー名の単純な一致パターンが含まれる場合があります。サポートされているパターンスタイルは、"xxx*"、"*xxx"、"*xxx*"、"xxx* yyy" です。
  - removeHeader
```
public MessageBuilder<T> removeHeader(StringSE headerName)
```
    指定されたヘッダー名の値を削除します。
  - copyHeaders
```
public MessageBuilder<T> copyHeaders(@Nullable
                                     MapSE<StringSE,?> headersToCopy)
```
    提供されたマップから名前と値のペアをコピーします。この操作は既存の値を上書きします。値の上書きを回避するには、{copyHeadersIfAbsent(Map) を使用します。"id" および "timestamp" ヘッダー値は決して上書きされないことに注意してください。
  - copyHeadersIfAbsent
```
public MessageBuilder<T> copyHeadersIfAbsent(@Nullable
                                             MapSE<StringSE,?> headersToCopy)
```
    提供されたマップから名前と値のペアをコピーします。この操作では、既存の値は上書きされません。
  - setReplyChannel
```
public MessageBuilder<T> setReplyChannel(MessageChannel replyChannel)
```
  - setReplyChannelName
```
public MessageBuilder<T> setReplyChannelName(StringSE replyChannelName)
```
  - setErrorChannel
```
public MessageBuilder<T> setErrorChannel(MessageChannel errorChannel)
```
  - setErrorChannelName
```
public MessageBuilder<T> setErrorChannelName(StringSE errorChannelName)
```
  - build
```
public Message<T> build()
```
  - fromMessage
```
public static <T> MessageBuilder<T> fromMessage(Message<T> message)
```
    指定されたメッセージからコピーされたすべてのヘッダーが事前に入力された新しい Message インスタンスのビルダーを作成します。提供されたメッセージのペイロードは、新しいメッセージのペイロードとしても使用されます。
    提供されたメッセージが ErrorMessage である場合、メッセージに含まれる originalMessage は新しいインスタンスに渡されます。
    パラメーター:
    message - ペイロードとすべてのヘッダーのコピー元のメッセージ
  - withPayload
```
public static <T> MessageBuilder<T> withPayload(T payload)
```
    指定されたペイロードでメッセージの新しいビルダーを作成します。
    パラメーター:
    payload - ペイロード
  - createMessage
```
public static <T> Message<T> createMessage(@Nullable
                                           T payload,
                                           MessageHeaders messageHeaders)
```
    指定されたペイロードと MessageHeaders を使用してメッセージを作成するためのショートカットファクトリメソッド。
    注意 : 指定された MessageHeaders インスタンスは新しいメッセージで直接使用されます。つまり、コピーされません。
    パラメーター:
    payload - 使用するペイロード (非 null)
    messageHeaders - 使用するヘッダー (非 null)
    戻り値:
    作成されたメッセージ
    導入:
    4.1

クラス MessageBuilder<T>

メソッドのサマリー

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

メソッドの詳細

setHeaders

setHeader

setHeaderIfAbsent

removeHeaders

removeHeader

copyHeaders

copyHeadersIfAbsent

setReplyChannel

setReplyChannelName

setErrorChannel

setErrorChannelName

build

fromMessage

withPayload

createMessage