Spring Framework 6.1.4 · org.springframework.messaging.simp.stomp.StompHeaders

Modifier and Type	Field and Description
public static final String	ACCEPT_VERSION
public static final String	ACK
public static final String	CONTENT_LENGTH
public static final String	CONTENT_TYPE
public static final String	DESTINATION
private final Map<String, List<String>>	headers
public static final String	HEARTBEAT
public static final String	HOST
public static final String	ID
public static final String	LOGIN
public static final String	MESSAGE_ID
public static final String	PASSCODE
public static final String	RECEIPT
public static final String	RECEIPT_ID
private static final long	serialVersionUID
public static final String	SERVER
public static final String	SESSION
public static final String	SUBSCRIPTION

Access	Constructor and Description
public	StompHeaders() Create a new instance to be populated with new header values.
private	StompHeaders(Map<String, List<String>> headers, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
public void	add(String the header name headerName, String the header value headerValue) Implements org.springframework.util.MultiValueMap.add. Add the given, single header value under the given name.
public void	addAll(String they key headerName, List<? extends String> the values to be added headerValues) Implements org.springframework.util.MultiValueMap.addAll. Add all the values of the given list to the current list of values for the given key.
public void	addAll(MultiValueMap<String, String> the values to be added values) Implements org.springframework.util.MultiValueMap.addAll. Add all the values of the given `MultiValueMap` to the current values.
public void	clear() Implements java.util.Map.clear. Removes all of the mappings from this map (optional operation).
public boolean	containsKey(Object key whose presence in this map is to be tested key) Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(Object value whose presence in this map is to be tested value) Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public Set<Map.Entry<String, List<String>>>	entrySet() Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
public boolean	equals(Object object to be compared for equality with this map other) Overrides java.lang.Object.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public List<String>	get(Object the key whose associated value is to be returned key) Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public String[]	getAcceptVersion() Get the accept-version header.
public String	getAck() Get the ack header.
public long	getContentLength() Return the content-length header or -1 if unknown.
public MimeType	getContentType() Return the content-type header value.
public String	getDestination() Get the destination header.
public String	Returns: the first header value, or `null` if none getFirst(String the header name headerName) Implements org.springframework.util.MultiValueMap.getFirst. Return the first header value for the given header name, if any.
public long[]	getHeartbeat() Get the heartbeat header.
public String	getHost() Get the host header.
public String	getId() Get the id header.
public String	getLogin() Get the login header.
public String	getMessageId() Get the message-id header.
public String	getPasscode() Get the passcode header.
public String	getReceipt() Get the receipt header.
public String	getReceiptId() Get the receipt header.
public String	getServer() Get the server header.
public String	getSession() Get the session header.
public String	getSubscription() Get the subscription header.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.hashCode. Returns the hash code value for this map.
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public boolean	isHeartbeatEnabled() Whether heartbeats are enabled.
public Set<String>	keySet() Implements java.util.Map.keySet. Returns a `Set` view of the keys contained in this map.
public List<String>	put(String key with which the specified value is to be associated key, List<String> value to be associated with the specified key value) Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(Map<? extends String, ? extends List<String>> mappings to be stored in this map map) Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public static StompHeaders	readOnlyStompHeaders(Map<String, List<String>> headers) Return a `StompHeaders` object that can only be read, not written to.
public List<String>	remove(Object key whose mapping is to be removed from the map key) Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
public void	set(String the header name headerName, String the header value headerValue) Implements org.springframework.util.MultiValueMap.set. Set the given, single header value under the given name.
public void	setAcceptVersion(String... acceptVersions) Set the accept-version header.
public void	setAck(String ack) Set the ack header to one of "auto", "client", or "client-individual".
public void	setAll(Map<String, String> the values. values) Implements org.springframework.util.MultiValueMap.setAll. Set the given values under.
public void	setContentLength(long contentLength) Set the content-length header.
public void	setContentType(MimeType mimeType) Set the content-type header.
public void	setDestination(String destination) Set the destination header.
public void	setHeartbeat(long[] heartbeat) Set the heartbeat header.
public void	setHost(String host) Set the host header.
public void	setId(String id) Set the id header.
public void	setLogin(String login) Set the login header.
public void	setMessageId(String messageId) Set the message-id header.
public void	setPasscode(String passcode) Set the passcode header.
public void	setReceipt(String receipt) Set the receipt header.
public void	setReceiptId(String receiptId) Set the receipt-id header.
public void	setServer(String server) Set the server header.
public void	setSession(String session) Set the session header.
public void	setSubscription(String subscription) Set the login header.
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public Map<String, String>	toSingleValueMap() Implements org.springframework.util.MultiValueMap.toSingleValueMap. Return a `Map` with the first values contained in this `MultiValueMap`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Collection<List<String>>	values() Implements java.util.Map.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

ACCEPT_VERSION	back to summary
public static final String ACCEPT_VERSION

ACK	back to summary
public static final String ACK

CONTENT_LENGTH	back to summary
public static final String CONTENT_LENGTH

CONTENT_TYPE	back to summary
public static final String CONTENT_TYPE

DESTINATION	back to summary
public static final String DESTINATION

headers	back to summary
private final Map<String, List<String>> headers Annotations @SuppressWarnings:serial

HEARTBEAT	back to summary
public static final String HEARTBEAT

HOST	back to summary
public static final String HOST

ID	back to summary
public static final String ID

LOGIN	back to summary
public static final String LOGIN

MESSAGE_ID	back to summary
public static final String MESSAGE_ID

PASSCODE	back to summary
public static final String PASSCODE

RECEIPT	back to summary
public static final String RECEIPT

RECEIPT_ID	back to summary
public static final String RECEIPT_ID

serialVersionUID	back to summary
private static final long serialVersionUID

SERVER	back to summary
public static final String SERVER

SESSION	back to summary
public static final String SESSION

SUBSCRIPTION	back to summary
public static final String SUBSCRIPTION

StompHeaders	back to summary
public StompHeaders() Create a new instance to be populated with new header values.

StompHeaders	back to summary
private StompHeaders(Map<String, List<String>> headers, boolean readOnly)

Method Detail

add back to summary

add	back to summary
public void add(String headerName, String headerValue) Implements org.springframework.util.MultiValueMap.add. Add the given, single header value under the given name. Parameters headerName:String the header name headerValue:String the header value Annotations @Override Exceptions UnsupportedOperationException: if adding headers is not supported See Also `put(String, List)`, `set(String, String)`

public void add(String headerName, String headerValue)

Implements org.springframework.util.MultiValueMap.add.

Add the given, single header value under the given name.

Parameters

headerName:String: the header name
headerValue:String: the header value

Annotations

@Override

Exceptions

UnsupportedOperationException:: if adding headers is not supported

addAll	back to summary
public void addAll(String headerName, List<? extends String> headerValues) Implements org.springframework.util.MultiValueMap.addAll. Doc from org.springframework.util.MultiValueMap.addAll. Add all the values of the given list to the current list of values for the given key. Parameters headerName:String they key headerValues:List<? extends String> the values to be added Annotations @Override

addAll

back to summary

public void addAll(String headerName, List<? extends String> headerValues)

Implements org.springframework.util.MultiValueMap.addAll.

Doc from org.springframework.util.MultiValueMap.addAll.

Add all the values of the given list to the current list of values for the given key.

Parameters

headerName:String: they key
headerValues:List<? extends String>: the values to be added

Annotations

@Override

addAll back to summary

addAll	back to summary
public void addAll(MultiValueMap<String, String> values) Implements org.springframework.util.MultiValueMap.addAll. Doc from org.springframework.util.MultiValueMap.addAll. Add all the values of the given `MultiValueMap` to the current values. Parameters values:MultiValueMap<String, String> the values to be added Annotations @Override

public void addAll(MultiValueMap<String, String> values)

Implements org.springframework.util.MultiValueMap.addAll.

Doc from org.springframework.util.MultiValueMap.addAll.

Add all the values of the given MultiValueMap to the current values.

Parameters

values:MultiValueMap<String, String>: the values to be added

Annotations

@Override

clear	back to summary
public void clear() Implements java.util.Map.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations

@Override

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object value) Implements java.util.Map.containsValue. Doc from java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value. More formally, returns `true` if and only if this map contains at least one mapping to a value `v` such that `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface. Parameters value:Object value whose presence in this map is to be tested Returns:boolean `true` if this map maps one or more keys to the specified value Annotations @Override

public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters

value:Object: value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

Annotations

@Override

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<String, List<String>>> entrySet() Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<Map.Entry<String, List<String>>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<String, List<String>>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<String, List<String>>>

a set view of the mappings contained in this map

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Implements java.util.Map.equals. Doc from java.util.Map.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. Parameters other:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to this map Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters

other:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations

@Override

get back to summary

get	back to summary
public List<String> get(Object key) Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:List<String> the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public List<String> get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:List<String>

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

getAcceptVersion	back to summary
public String[] getAcceptVersion() Get the accept-version header. Annotations @Nullable Since 5.0.7

getAcceptVersion

back to summary

public String[] getAcceptVersion()

Get the accept-version header.

Annotations

@Nullable

Since

5.0.7

getAck	back to summary
public String getAck() Get the ack header. Annotations @Nullable

getAck

back to summary

public String getAck()

Get the ack header.

Annotations

@Nullable

getContentLength	back to summary
public long getContentLength() Return the content-length header or -1 if unknown.

getContentType	back to summary
public MimeType getContentType() Return the content-type header value. Annotations @Nullable

getContentType

back to summary

public MimeType getContentType()

Return the content-type header value.

Annotations

@Nullable

getDestination	back to summary
public String getDestination() Get the destination header. Applies to the SEND, SUBSCRIBE, and MESSAGE frames. Annotations @Nullable

getDestination

back to summary

public String getDestination()

Get the destination header. Applies to the SEND, SUBSCRIBE, and MESSAGE frames.

Annotations

@Nullable

getFirst back to summary

getFirst	back to summary
public String getFirst(String headerName) Implements org.springframework.util.MultiValueMap.getFirst. Return the first header value for the given header name, if any. Parameters headerName:String the header name Returns:String the first header value, or `null` if none Annotations @Override @Nullable

public String getFirst(String headerName)

Implements org.springframework.util.MultiValueMap.getFirst.

Return the first header value for the given header name, if any.

Parameters

headerName:String: the header name

Returns:String

the first header value, or null if none

Annotations

@Override
@Nullable

getHeartbeat	back to summary
public long[] getHeartbeat() Get the heartbeat header. Annotations @Nullable

getHeartbeat

back to summary

public long[] getHeartbeat()

Get the heartbeat header.

Annotations

@Nullable

getHost	back to summary
public String getHost() Get the host header. Annotations @Nullable

getHost

back to summary

public String getHost()

Get the host header.

Annotations

@Nullable

getId	back to summary
public String getId() Get the id header. Annotations @Nullable

getId

back to summary

public String getId()

Get the id header.

Annotations

@Nullable

getLogin	back to summary
public String getLogin() Get the login header. Annotations @Nullable

getLogin

back to summary

public String getLogin()

Get the login header.

Annotations

@Nullable

getMessageId	back to summary
public String getMessageId() Get the message-id header. Annotations @Nullable

getMessageId

back to summary

public String getMessageId()

Get the message-id header.

Annotations

@Nullable

getPasscode	back to summary
public String getPasscode() Get the passcode header. Annotations @Nullable

getPasscode

back to summary

public String getPasscode()

Get the passcode header.

Annotations

@Nullable

getReceipt	back to summary
public String getReceipt() Get the receipt header. Annotations @Nullable

getReceipt

back to summary

public String getReceipt()

Get the receipt header.

Annotations

@Nullable

getReceiptId	back to summary
public String getReceiptId() Get the receipt header. Annotations @Nullable

getReceiptId

back to summary

public String getReceiptId()

Get the receipt header.

Annotations

@Nullable

getServer	back to summary
public String getServer() Get the server header. Applies to the CONNECTED frame. Annotations @Nullable

getServer

back to summary

public String getServer()

Get the server header. Applies to the CONNECTED frame.

Annotations

@Nullable

getSession	back to summary
public String getSession() Get the session header. Annotations @Nullable

getSession

back to summary

public String getSession()

Get the session header.

Annotations

@Nullable

getSubscription	back to summary
public String getSubscription() Get the subscription header. Annotations @Nullable

getSubscription

back to summary

public String getSubscription()

Get the subscription header.

Annotations

@Nullable

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.hashCode. Doc from java.util.Map.hashCode. Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's `entrySet()` view. This ensures that `m1.equals(m2)` implies that `m1.hashCode()==m2.hashCode()` for any two maps `m1` and `m2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this map Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.Map.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations

@Override

isEmpty back to summary

public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations

@Override

isHeartbeatEnabled	back to summary
public boolean isHeartbeatEnabled() Whether heartbeats are enabled. Returns `false` if `setHeartbeat` is set to "0,0", and `true` otherwise.

keySet back to summary

public Set<String> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<String>

a set view of the keys contained in this map

Annotations

@Override

put back to summary

public List<String> put(String key, List<String> value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

key:String: key with which the specified value is to be associated
value:List<String>: value to be associated with the specified key

Returns:List<String>

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations

@Override

putAll back to summary

public void putAll(Map<? extends String, ? extends List<String>> map)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters

map:Map<? extends String, ? extends List<String>>: mappings to be stored in this map

Annotations

@Override

readOnlyStompHeaders	back to summary
public static StompHeaders readOnlyStompHeaders(Map<String, List<String>> headers) Return a `StompHeaders` object that can only be read, not written to.

remove back to summary

public List<String> remove(Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

key:Object: key whose mapping is to be removed from the map

Returns:List<String>

the previous value associated with key, or null if there was no mapping for key.

Annotations

@Override

set back to summary

public void set(String headerName, String headerValue)

Implements org.springframework.util.MultiValueMap.set.

Set the given, single header value under the given name.

Parameters

headerName:String: the header name
headerValue:String: the header value

Annotations

@Override

Exceptions

UnsupportedOperationException:: if adding headers is not supported

setAcceptVersion

back to summary

public void setAcceptVersion(String... acceptVersions)

Set the accept-version header. Must be one of "1.1", "1.2", or both. Applies to the CONNECT frame.

Since: 5.0.7

setAck	back to summary
public void setAck(String ack) Set the ack header to one of "auto", "client", or "client-individual". Applies to the SUBSCRIBE and MESSAGE frames.

setAll

back to summary

public void setAll(Map<String, String> values)

Implements org.springframework.util.MultiValueMap.setAll.

Doc from org.springframework.util.MultiValueMap.setAll.

Set the given values under.

Parameters

values:Map<String, String>: the values.

Annotations

@Override

setContentLength	back to summary
public void setContentLength(long contentLength) Set the content-length header. Applies to the SEND, MESSAGE, and ERROR frames.

setContentType	back to summary
public void setContentType(MimeType mimeType) Set the content-type header. Applies to the SEND, MESSAGE, and ERROR frames.

setDestination	back to summary
public void setDestination(String destination) Set the destination header.

setHeartbeat	back to summary
public void setHeartbeat(long[] heartbeat) Set the heartbeat header. Applies to the CONNECT and CONNECTED frames.

setHost	back to summary
public void setHost(String host) Set the host header. Applies to the CONNECT frame.

setId	back to summary
public void setId(String id) Set the id header. Applies to the SUBSCR0BE, UNSUBSCRIBE, and ACK or NACK frames.

setLogin	back to summary
public void setLogin(String login) Set the login header. Applies to the CONNECT frame.

setMessageId	back to summary
public void setMessageId(String messageId) Set the message-id header. Applies to the MESSAGE frame.

setPasscode	back to summary
public void setPasscode(String passcode) Set the passcode header. Applies to the CONNECT frame.

setReceipt	back to summary
public void setReceipt(String receipt) Set the receipt header. Applies to any client frame other than CONNECT.

setReceiptId	back to summary
public void setReceiptId(String receiptId) Set the receipt-id header. Applies to the RECEIPT frame.

setServer	back to summary
public void setServer(String server) Set the server header. Applies to the CONNECTED frame.

setSession	back to summary
public void setSession(String session) Set the session header. Applies to the CONNECTED frame.

setSubscription	back to summary
public void setSubscription(String subscription) Set the login header. Applies to the MESSAGE frame.

size back to summary

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations

@Override

toSingleValueMap back to summary

public Map<String, String> toSingleValueMap()

Implements org.springframework.util.MultiValueMap.toSingleValueMap.

Doc from org.springframework.util.MultiValueMap.toSingleValueMap.

Return a Map with the first values contained in this MultiValueMap.

Returns:Map<String, String>

a single value representation of this map

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

values back to summary

public Collection<List<String>> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<List<String>>

a collection view of the values contained in this map

Annotations

@Override

public Class StompHeaders

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail