Class HttpComponentsHeadersAdapter

java.lang.Object

org.springframework.http.support.HttpComponentsHeadersAdapter

All Implemented Interfaces:

Map<String, List<String>>, MultiValueMap<String,String>

public final class HttpComponentsHeadersAdapter
extends Object
implements MultiValueMap<String,String>

MultiValueMap implementation for wrapping Apache HttpComponents HttpClient headers.

Since:

6.1

Author:

Rossen Stoyanchev, Simon Baslé

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
HttpComponentsHeadersAdapter(org.apache.hc.core5.http.HttpMessage message)	Create a new HttpComponentsHeadersAdapter based on the given HttpMessage.

Method Summary

Modifier and Type	Method	Description
void	add(String key, @Nullable String value)	Add the given single value to the current list of values for the given key.
void	addAll(String key, List<? extends String> values)	Add all the values of the given list to the current list of values for the given key.
void	addAll(MultiValueMap<String,String> values)	Add all the values of the given MultiValueMap to the current values.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String, List<String>>>	entrySet()
@Nullable List<String>	get(Object key)
@Nullable String	getFirst(String key)	Return the first value for the given key.
boolean	isEmpty()
Set<String>	keySet()
@Nullable List<String>	put(String key, List<String> values)
void	putAll(Map<? extends String, ? extends List<String>> map)
@Nullable List<String>	remove(Object key)
void	set(String key, @Nullable String value)	Set the given single value under the given key.
void	setAll(Map<String,String> values)	Set the given values under.
int	size()
Map<String,String>	toSingleValueMap()	Return a Map with the first values contained in this MultiValueMap.
String	toString()
Collection<List<String>>	values()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface MultiValueMap

addIfAbsent, asSingleValueMap

Constructor Details

HttpComponentsHeadersAdapter

public HttpComponentsHeadersAdapter(org.apache.hc.core5.http.HttpMessage message)

Create a new HttpComponentsHeadersAdapter based on the given HttpMessage.

Method Details

getFirst

public @Nullable String getFirst(String key)

Description copied from interface: MultiValueMap

Return the first value for the given key.

Specified by:

getFirst in interface MultiValueMap<String,String>

Parameters:

key - the key

Returns:

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

add

public void add(String key,
 @Nullable String value)

Description copied from interface: MultiValueMap

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

Specified by:

add in interface MultiValueMap<String,String>

Parameters:

key - the key

value - the value to be added

addAll

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

Description copied from interface: MultiValueMap

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

Specified by:

addAll in interface MultiValueMap<String,String>

Parameters:

key - they key

values - the values to be added

addAll

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

Description copied from interface: MultiValueMap

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

Specified by:

addAll in interface MultiValueMap<String,String>

Parameters:

values - the values to be added

set

public void set(String key,
 @Nullable String value)

Description copied from interface: MultiValueMap

Set the given single value under the given key.

Specified by:

set in interface MultiValueMap<String,String>

Parameters:

key - the key

value - the value to set

setAll

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

Description copied from interface: MultiValueMap

Set the given values under.

Specified by:

setAll in interface MultiValueMap<String,String>

Parameters:

values - the values.

toSingleValueMap

public Map<String,String> toSingleValueMap()

Description copied from interface: MultiValueMap

Return a Map with the first values contained in this MultiValueMap. The difference between this method and MultiValueMap.asSingleValueMap() is that this method returns a copy of the entries of this map, whereas the latter returns a view.

Specified by:

toSingleValueMap in interface MultiValueMap<String,String>

Returns:

a single value representation of this map

size

public int size()

Specified by:

size in interface Map<String, List<String>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String, List<String>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String, List<String>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String, List<String>>

get

public @Nullable List<String> get(Object key)

Specified by:

get in interface Map<String, List<String>>

put

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

Specified by:

put in interface Map<String, List<String>>

remove

public @Nullable List<String> remove(Object key)

Specified by:

remove in interface Map<String, List<String>>

putAll

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

Specified by:

putAll in interface Map<String, List<String>>

clear

public void clear()

Specified by:

clear in interface Map<String, List<String>>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String, List<String>>

values

public Collection<List<String>> values()

Specified by:

values in interface Map<String, List<String>>

entrySet

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

Specified by:

entrySet in interface Map<String, List<String>>

toString

public String toString()

Overrides:

toString in class Object