Spring Framework 6.1.4 · org.springframework.http.support.HttpComponentsHeadersAdapter

Modifier and Type	Class and Description
private class	HttpComponentsHeadersAdapter.EntryIterator
private class	HttpComponentsHeadersAdapter.HeaderEntry

Modifier and Type	Field and Description
private final HttpMessage	message

Access	Constructor and Description
public	HttpComponentsHeadersAdapter(HttpMessage message) Create a new `HttpComponentsHeadersAdapter` based on the given `HttpMessage`.

Method Summary

Modifier and Type	Method and Description
public void	add(String the key key, String the value to be added value) Implements org.springframework.util.MultiValueMap.add. Add the given single value to the current list of values for the given key.
public void	addAll(String they key key, List<? extends String> the values to be added values) 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 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	getFirst(String the key key) Implements org.springframework.util.MultiValueMap.getFirst. Return the first value for the given key.
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
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 values) 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 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 key key, String the value to set value) Implements org.springframework.util.MultiValueMap.set. Set the given single value under the given key.
public void	setAll(Map<String, String> the values. values) Implements org.springframework.util.MultiValueMap.setAll. Set the given values under.
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 equals finalize getClass hashCode notify notifyAll wait wait wait

message	back to summary
private final HttpMessage message

HttpComponentsHeadersAdapter	back to summary
public HttpComponentsHeadersAdapter(HttpMessage message) Create a new `HttpComponentsHeadersAdapter` based on the given `HttpMessage`.

Method Detail

add	back to summary
public void add(String key, String value) Implements org.springframework.util.MultiValueMap.add. Doc from org.springframework.util.MultiValueMap.add. Add the given single value to the current list of values for the given key. Parameters key:String the key value:String the value to be added Annotations @Override

add

back to summary

public void add(String key, String value)

Implements org.springframework.util.MultiValueMap.add.

Doc from org.springframework.util.MultiValueMap.add.

Add the given single value to the current list of values for the given key.

Parameters

key:String: the key
value:String: the value to be added

Annotations

@Override

addAll	back to summary
public void addAll(String key, List<? extends String> values) 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 key:String they key values:List<? extends String> the values to be added Annotations @Override

addAll

back to summary

public void addAll(String key, List<? extends String> values)

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

key:String: they key
values: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

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 @Nullable @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

@Nullable
@Override

getFirst back to summary

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

public String getFirst(String key)

Implements org.springframework.util.MultiValueMap.getFirst.

Doc from org.springframework.util.MultiValueMap.getFirst.

Return the first value for the given key.

Parameters

key:String: the key

Returns:String

the first value for the specified key, or null if none

Annotations

@Override
@Nullable

isEmpty back to summary

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

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

keySet back to summary

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

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

put	back to summary
public List<String> put(String key, List<String> values) 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 values: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 @Nullable @Override

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

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
values: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

@Nullable
@Override

putAll back to summary

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

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

remove back to summary

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 @Nullable @Override

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

@Nullable
@Override

set	back to summary
public void set(String key, String value) Implements org.springframework.util.MultiValueMap.set. Doc from org.springframework.util.MultiValueMap.set. Set the given single value under the given key. Parameters key:String the key value:String the value to set Annotations @Override

set

back to summary

public void set(String key, String value)

Implements org.springframework.util.MultiValueMap.set.

Doc from org.springframework.util.MultiValueMap.set.

Set the given single value under the given key.

Parameters

key:String: the key
value:String: the value to set

Annotations

@Override

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

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

size back to summary

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

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

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

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

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

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

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 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 final Class HttpComponentsHeadersAdapter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HttpComponentsHeadersAdapter.EntryIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HttpComponentsHeadersAdapter.HeaderEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Map.Entry<String, List<String>>	next() Implements java.util.Iterator.next. Returns the next element in the iteration.

Modifier and Type	Method and Description
public String	getKey() Implements java.util.Map.Entry.getKey. Returns the key corresponding to this entry.
public List<String>	getValue() Implements java.util.Map.Entry.getValue. Returns the value corresponding to this entry.
public List<String>	setValue(List<String> new value to be stored in this entry value) Implements java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation).