StompHeaders (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.messaging.simp.stomp.StompHeaders

実装されているすべてのインターフェース:
SerializableSE, MapSE<StringSE, ListSE<StringSE>>, MultiValueMap<StringSE, StringSE>
```
public class StompHeaders
extends ObjectSE
implements MultiValueMap<StringSE,StringSE>, SerializableSE
```
STOMP フレームヘッダーを表します。
MapSE で定義されている通常のメソッドに加えて、このクラスは次の便利なメソッドを提供します。
- getFirst(String) はヘッダー名の最初の値を返します
- add(String, String) は、ヘッダー名の値のリストに追加します
- set(String, String) はヘッダー名を単一の文字列値に設定します
導入:
4.2
作成者:
Rossen Stoyanchev
関連事項:
http://stomp.github.io/stomp-specification-1.2.html#Frames_and_Headers , 連載形式

ネストされたクラスの要約
- インターフェース java.util.MapSE から継承されたネストクラス / インターフェース
  Map.EntrySE<KSE, VSE>

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`ACK`
`static StringSE`	`CONTENT_LENGTH`
`static StringSE`	`CONTENT_TYPE`
`static StringSE`	`DESTINATION`
`static StringSE`	`HEARTBEAT`
`static StringSE`	`HOST`
`static StringSE`	`ID`
`static StringSE`	`LOGIN`
`static StringSE`	`MESSAGE_ID`
`static StringSE`	`PASSCODE`
`static StringSE`	`RECEIPT`
`static StringSE`	`RECEIPT_ID`
`static StringSE`	`SERVER`
`static StringSE`	`SESSION`
`static StringSE`	`SUBSCRIPTION`

コンストラクターの概要
コンストラクター
コンストラクターと説明
StompHeaders()
新しいヘッダー値を入力する新しいインスタンスを作成します。

コンストラクター
コンストラクターと説明
`StompHeaders()` 新しいヘッダー値を入力する新しいインスタンスを作成します。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`add(StringSE headerName, StringSE headerValue)` 指定された名前に、指定された単一のヘッダー値を追加します。
`void`	`addAll(MultiValueMap<StringSE, StringSE> values)` 指定された `MultiValueMap` のすべての値を現在の値に追加します。
`void`	`addAll(StringSE headerName, ListSE<? extends StringSE> headerValues)` 指定されたリストのすべての値を、指定されたキーの現在の値のリストに追加します。
`void`	`clear()`
`boolean`	`containsKey(ObjectSE key)`
`boolean`	`containsValue(ObjectSE value)`
`SetSE<Map.EntrySE<StringSE, ListSE<StringSE>>>`	`entrySet()`
`boolean`	`equals(ObjectSE other)`
`ListSE<StringSE>`	`get(ObjectSE key)`
`StringSE`	`getAck()` ack ヘッダーを取得します。
`long`	`getContentLength()` content-length ヘッダーを返します。不明な場合は -1 を返します。
`MimeType`	`getContentType()` content-type ヘッダー値を返します。
`StringSE`	`getDestination()` 宛先ヘッダーを取得します。
`StringSE`	`getFirst(StringSE headerName)` 指定されたヘッダー名の最初のヘッダー値があれば、それを返します。
`long[]`	`getHeartbeat()` ハートビートヘッダーを取得します。
`StringSE`	`getHost()` ホストヘッダーを取得します。
`StringSE`	`getId()` id ヘッダーを取得します。
`StringSE`	`getLogin()` ログインヘッダーを取得します。
`StringSE`	`getMessageId()` メッセージ ID ヘッダーを取得します。
`StringSE`	`getPasscode()` パスコードヘッダーを取得します。
`StringSE`	`getReceipt()` 領収書ヘッダーを取得します。
`StringSE`	`getReceiptId()` 領収書ヘッダーを取得します。
`StringSE`	`getServer()` サーバーヘッダーを取得します。
`StringSE`	`getSession()` セッションヘッダーを取得します。
`StringSE`	`getSubscription()` サブスクリプションヘッダーを取得します。
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isHeartbeatEnabled()` ハートビートが有効かどうか。
`SetSE<StringSE>`	`keySet()`
`ListSE<StringSE>`	`put(StringSE key, ListSE<StringSE> value)`
`void`	`putAll(MapSE<? extends StringSE,? extends ListSE<StringSE>> map)`
`static StompHeaders`	`readOnlyStompHeaders(MapSE<StringSE, ListSE<StringSE>> headers)` 読み取りのみが可能で、書き込みはできない `StompHeaders` オブジェクトを返します。
`ListSE<StringSE>`	`remove(ObjectSE key)`
`void`	`set(StringSE headerName, StringSE headerValue)` 指定された名前に、指定された単一のヘッダー値を設定します。
`void`	`setAck(StringSE ack)` ack ヘッダーを "auto"、"client"、"client-individual" のいずれかに設定します。
`void`	`setAll(MapSE<StringSE, StringSE> values)` 指定された値を下に設定します。
`void`	`setContentLength(long contentLength)` content-length ヘッダーを設定します。
`void`	`setContentType(MimeType mimeType)` content-type ヘッダーを設定します。
`void`	`setDestination(StringSE destination)` 宛先ヘッダーを設定します。
`void`	`setHeartbeat(long[] heartbeat)` ハートビートヘッダーを設定します。
`void`	`setHost(StringSE host)` ホストヘッダーを設定します。
`void`	`setId(StringSE id)` id ヘッダーを設定します。
`void`	`setLogin(StringSE login)` ログインヘッダーを設定します。
`void`	`setMessageId(StringSE messageId)` メッセージ ID ヘッダーを設定します。
`void`	`setPasscode(StringSE passcode)` パスコードヘッダーを設定します。
`void`	`setReceipt(StringSE receipt)` 受信ヘッダーを設定します。
`void`	`setReceiptId(StringSE receiptId)` receive-id ヘッダーを設定します。
`void`	`setServer(StringSE server)` サーバーヘッダーを設定します。
`void`	`setSession(StringSE session)` セッションヘッダーを設定します。
`void`	`setSubscription(StringSE subscription)` ログインヘッダーを設定します。
`int`	`size()`
`MapSE<StringSE, StringSE>`	`toSingleValueMap()` この `MultiValueMap` に含まれる最初の値を返します。
`StringSE`	`toString()`
`CollectionSE<ListSE<StringSE>>`	`values()`

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

インターフェース java.util.MapSE から継承されたメソッド
computeSE, computeIfAbsentSE, computeIfPresentSE, forEachSE, getOrDefaultSE, mergeSE, putIfAbsentSE, removeSE, replaceSE, replaceSE, replaceAllSE

- フィールドの詳細
  - CONTENT_TYPE
```
public static final StringSE CONTENT_TYPE
```
    関連事項:
    定数フィールド値
  - CONTENT_LENGTH
```
public static final StringSE CONTENT_LENGTH
```
    関連事項:
    定数フィールド値
  - RECEIPT
```
public static final StringSE RECEIPT
```
    関連事項:
    定数フィールド値
  - HOST
```
public static final StringSE HOST
```
    関連事項:
    定数フィールド値
  - LOGIN
```
public static final StringSE LOGIN
```
    関連事項:
    定数フィールド値
  - PASSCODE
```
public static final StringSE PASSCODE
```
    関連事項:
    定数フィールド値
  - HEARTBEAT
```
public static final StringSE HEARTBEAT
```
    関連事項:
    定数フィールド値
  - SESSION
```
public static final StringSE SESSION
```
    関連事項:
    定数フィールド値
  - SERVER
```
public static final StringSE SERVER
```
    関連事項:
    定数フィールド値
  - DESTINATION
```
public static final StringSE DESTINATION
```
    関連事項:
    定数フィールド値
  - ID
```
public static final StringSE ID
```
    関連事項:
    定数フィールド値
  - ACK
```
public static final StringSE ACK
```
    関連事項:
    定数フィールド値
  - SUBSCRIPTION
```
public static final StringSE SUBSCRIPTION
```
    関連事項:
    定数フィールド値
  - MESSAGE_ID
```
public static final StringSE MESSAGE_ID
```
    関連事項:
    定数フィールド値
  - RECEIPT_ID
```
public static final StringSE RECEIPT_ID
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - StompHeaders
```
public StompHeaders()
```
    新しいヘッダー値を入力する新しいインスタンスを作成します。
- メソッドの詳細
  - setContentType
```
public void setContentType(@Nullable
                           MimeType mimeType)
```
    content-type ヘッダーを設定します。SEND、MESSAGE、ERROR フレームに適用されます。
  - getContentType
```
@Nullable
public MimeType getContentType()
```
    content-type ヘッダー値を返します。
  - setContentLength
```
public void setContentLength(long contentLength)
```
    content-length ヘッダーを設定します。SEND、MESSAGE、ERROR フレームに適用されます。
  - getContentLength
```
public long getContentLength()
```
    content-length ヘッダーを返します。不明な場合は -1 を返します。
  - setReceipt
```
public void setReceipt(@Nullable
                       StringSE receipt)
```
    受信ヘッダーを設定します。CONNECT 以外のクライアントフレームに適用されます。
  - getReceipt
```
@Nullable
public StringSE getReceipt()
```
    領収書ヘッダーを取得します。
  - setHost
```
public void setHost(@Nullable
                    StringSE host)
```
    ホストヘッダーを設定します。CONNECT フレームに適用されます。
  - getHost
```
@Nullable
public StringSE getHost()
```
    ホストヘッダーを取得します。
  - setLogin
```
public void setLogin(@Nullable
                     StringSE login)
```
    ログインヘッダーを設定します。CONNECT フレームに適用されます。
  - getLogin
```
@Nullable
public StringSE getLogin()
```
    ログインヘッダーを取得します。
  - setPasscode
```
public void setPasscode(@Nullable
                        StringSE passcode)
```
    パスコードヘッダーを設定します。CONNECT フレームに適用されます。
  - getPasscode
```
@Nullable
public StringSE getPasscode()
```
    パスコードヘッダーを取得します。
  - setHeartbeat
```
public void setHeartbeat(@Nullable
                         long[] heartbeat)
```
    ハートビートヘッダーを設定します。CONNECT および CONNECTED フレームに適用されます。
  - getHeartbeat
```
@Nullable
public long[] getHeartbeat()
```
    ハートビートヘッダーを取得します。
  - isHeartbeatEnabled
```
public boolean isHeartbeatEnabled()
```
    ハートビートが有効かどうか。setHeartbeat(long[]) が "0,0" に設定されている場合は false を返し、それ以外の場合は true を返します。
  - setSession
```
public void setSession(@Nullable
                       StringSE session)
```
    セッションヘッダーを設定します。CONNECTED フレームに適用されます。
  - getSession
```
@Nullable
public StringSE getSession()
```
    セッションヘッダーを取得します。
  - setServer
```
public void setServer(@Nullable
                      StringSE server)
```
    サーバーヘッダーを設定します。CONNECTED フレームに適用されます。
  - getServer
```
@Nullable
public StringSE getServer()
```
    サーバーヘッダーを取得します。CONNECTED フレームに適用されます。
  - setDestination
```
public void setDestination(@Nullable
                           StringSE destination)
```
    宛先ヘッダーを設定します。
  - getDestination
```
@Nullable
public StringSE getDestination()
```
    宛先ヘッダーを取得します。SEND、SUBSCRIBE、MESSAGE フレームに適用されます。
  - setId
```
public void setId(@Nullable
                  StringSE id)
```
    id ヘッダーを設定します。SUBSCR0BE、UNSUBSCRIBE、ACK または NACK フレームに適用されます。
  - getId
```
@Nullable
public StringSE getId()
```
    id ヘッダーを取得します。
  - setAck
```
public void setAck(@Nullable
                   StringSE ack)
```
    ack ヘッダーを "auto"、"client"、"client-individual" のいずれかに設定します。SUBSCRIBE および MESSAGE フレームに適用されます。
  - getAck
```
@Nullable
public StringSE getAck()
```
    ack ヘッダーを取得します。
  - setSubscription
```
public void setSubscription(@Nullable
                            StringSE subscription)
```
    ログインヘッダーを設定します。MESSAGE フレームに適用されます。
  - getSubscription
```
@Nullable
public StringSE getSubscription()
```
    サブスクリプションヘッダーを取得します。
  - setMessageId
```
public void setMessageId(@Nullable
                         StringSE messageId)
```
    message-id ヘッダーを設定します。MESSAGE フレームに適用されます。
  - getMessageId
```
@Nullable
public StringSE getMessageId()
```
    メッセージ ID ヘッダーを取得します。
  - setReceiptId
```
public void setReceiptId(@Nullable
                         StringSE receiptId)
```
    receive-id ヘッダーを設定します。RECEIPT フレームに適用されます。
  - getReceiptId
```
@Nullable
public StringSE getReceiptId()
```
    領収書ヘッダーを取得します。
  - getFirst
```
@Nullable
public StringSE getFirst(StringSE headerName)
```
    指定されたヘッダー名の最初のヘッダー値があれば、それを返します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の getFirst
    パラメーター:
    headerName - ヘッダー名
    戻り値:
    最初のヘッダー値、ない場合は null
  - add
```
public void add(StringSE headerName,
                @Nullable
                StringSE headerValue)
```
    指定された名前に、指定された単一のヘッダー値を追加します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の add
    パラメーター:
    headerName - ヘッダー名
    headerValue - ヘッダー値
    例外:
    UnsupportedOperationExceptionSE - ヘッダーの追加がサポートされていない場合
    関連事項:
    put(String, List), set(String, String)
  - addAll
```
public void addAll(StringSE headerName,
                   ListSE<? extends StringSE> headerValues)
```
    インターフェースからコピーされた説明: MultiValueMap
    指定されたリストのすべての値を、指定されたキーの現在の値のリストに追加します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の addAll
    パラメーター:
    headerName - 彼らはキー
    headerValues - 追加する値
  - addAll
```
public void addAll(MultiValueMap<StringSE,StringSE> values)
```
    インターフェースからコピーされた説明: MultiValueMap
    指定された MultiValueMap のすべての値を現在の値に追加します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の addAll
    パラメーター:
    values - 追加する値
  - set
```
public void set(StringSE headerName,
                @Nullable
                StringSE headerValue)
```
    指定された名前に、指定された単一のヘッダー値を設定します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の set
    パラメーター:
    headerName - ヘッダー名
    headerValue - ヘッダー値
    例外:
    UnsupportedOperationExceptionSE - ヘッダーの追加がサポートされていない場合
    関連事項:
    put(String, List), add(String, String)
  - setAll
```
public void setAll(MapSE<StringSE,StringSE> values)
```
    インターフェースからコピーされた説明: MultiValueMap
    指定された値を下に設定します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の setAll
    パラメーター:
    values - 値。
  - toSingleValueMap
```
public MapSE<StringSE,StringSE> toSingleValueMap()
```
    インターフェースからコピーされた説明: MultiValueMap
    この MultiValueMap に含まれる最初の値を返します。
    次で指定:
    インターフェース MultiValueMap<StringSE, StringSE> の toSingleValueMap
    戻り値:
    このマップの単一値表現
  - size
```
public int size()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の sizeSE
  - isEmpty
```
public boolean isEmpty()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の isEmptySE
  - containsKey
```
public boolean containsKey(ObjectSE key)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の containsKeySE
  - containsValue
```
public boolean containsValue(ObjectSE value)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の containsValueSE
  - get
```
public ListSE<StringSE> get(ObjectSE key)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の getSE
  - put
```
public ListSE<StringSE> put(StringSE key,
                        ListSE<StringSE> value)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の putSE
  - remove
```
public ListSE<StringSE> remove(ObjectSE key)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の removeSE
  - putAll
```
public void putAll(MapSE<? extends StringSE,? extends ListSE<StringSE>> map)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の putAllSE
  - clear
```
public void clear()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の clearSE
  - keySet
```
public SetSE<StringSE> keySet()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の keySetSE
  - values
```
public CollectionSE<ListSE<StringSE>> values()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の valuesSE
  - entrySet
```
public SetSE<Map.EntrySE<StringSE,ListSE<StringSE>>> entrySet()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の entrySetSE
  - equals
```
public boolean equals(ObjectSE other)
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の equalsSE
    オーバーライド:
    クラス ObjectSE の equalsSE
  - hashCode
```
public int hashCode()
```
    次で指定:
    インターフェース MapSE<StringSE, ListSE<StringSE>> の hashCodeSE
    オーバーライド:
    クラス ObjectSE の hashCodeSE
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE
  - readOnlyStompHeaders
```
public static StompHeaders readOnlyStompHeaders(@Nullable
                                                MapSE<StringSE,ListSE<StringSE>> headers)
```
    読み取りのみが可能で、書き込みはできない StompHeaders オブジェクトを返します。

クラス StompHeaders

ネストされたクラスの要約

インターフェース java.util.MapSE から継承されたネストクラス / インターフェース

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

インターフェース java.util.MapSE から継承されたメソッド

フィールドの詳細

CONTENT_TYPE

CONTENT_LENGTH

RECEIPT

HOST

LOGIN

PASSCODE

HEARTBEAT

SESSION

SERVER

DESTINATION

ID

ACK

SUBSCRIPTION

MESSAGE_ID

RECEIPT_ID

コンストラクターの詳細

StompHeaders

メソッドの詳細

setContentType

getContentType

setContentLength

getContentLength

setReceipt

getReceipt

setHost

getHost

setLogin

getLogin

setPasscode

getPasscode

setHeartbeat

getHeartbeat

isHeartbeatEnabled

setSession

getSession

setServer

getServer

setDestination

getDestination

setId

getId

setAck

getAck

setSubscription

getSubscription

setMessageId

getMessageId

setReceiptId

getReceiptId

getFirst

add

addAll

addAll

set

setAll

toSingleValueMap

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

toString