public Class WebSocketHttpHeaders

Create a new instance.

Create an instance that wraps the given pre-existing HttpHeaders and also propagate all changes to it.

Parameters

headers:HttpHeaders

the HTTP headers to wrap

Overrides org.springframework.http.HttpHeaders.add.

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)

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.containsKey.

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

Overrides org.springframework.http.HttpHeaders.containsValue.

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

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.forEach.

Overrides default java.util.Map.forEach.

Doc from java.util.Map.forEach.

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.

Parameters

action:BiConsumer<? super String, ? super List<String>>

The action to be performed for each entry

Annotations

@Override

Overrides org.springframework.http.HttpHeaders.get.

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

Overrides org.springframework.http.HttpHeaders.getFirst.

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

Annotations

@Override

@Nullable

Returns the value of the Sec-WebSocket-Accept header.

Returns:String

the value of the header

Annotations

@Nullable

Returns the value of the Sec-WebSocket-Extensions header.

Returns:List<WebSocketExtension>

the value of the header

Returns the value of the Sec-WebSocket-Key header.

Returns:String

the value of the header

Annotations

@Nullable

Returns the value of the Sec-WebSocket-Key header.

Returns:List<String>

the value of the header

Returns the value of the Sec-WebSocket-Version header.

Returns:String

the value of the header

Annotations

@Nullable

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.put.

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

Overrides org.springframework.http.HttpHeaders.putAll.

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

m:Map<? extends String, ? extends List<String>>

mappings to be stored in this map

Annotations

@Override

Overrides org.springframework.http.HttpHeaders.putIfAbsent.

Overrides default java.util.Map.putIfAbsent.

Doc from java.util.Map.putIfAbsent.

If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value (optional operation).

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 the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)

Annotations

@Override

Overrides org.springframework.http.HttpHeaders.remove.

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

Overrides org.springframework.http.HttpHeaders.set.

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

See Also

put(String, List), add(String, String)

Overrides org.springframework.http.HttpHeaders.setAll.

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

Sets the (new) value of the Sec-WebSocket-Accept header.

Parameters

secWebSocketAccept:String

the value of the header

Sets the (new) value(s) of the Sec-WebSocket-Extensions header.

Parameters

extensions:List<WebSocketExtension>

the values for the header

Sets the (new) value of the Sec-WebSocket-Key header.

Parameters

secWebSocketKey:String

the value of the header

Sets the (new) value of the Sec-WebSocket-Protocol header.

Parameters

secWebSocketProtocol:String

the value of the header

Sets the (new) value of the Sec-WebSocket-Protocol header.

Parameters

secWebSocketProtocols:List<String>

the value of the header

Sets the (new) value of the Sec-WebSocket-Version header.

Parameters

secWebSocketVersion:String

the value of the header

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.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

Overrides org.springframework.http.HttpHeaders.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