Top Description Inners Fields Constructors Methods
org.springframework.http.support

public final Class Netty5HeadersAdapter

extends Object
implements MultiValueMap<String, String>
Class Inheritance
All Implemented Interfaces
org.springframework.util.MultiValueMap, java.util.Map
Imports
java.util.AbstractSet, .ArrayList, .Collection, .Collections, .Iterator, .List, .Map, .Set, java.util.stream.StreamSupport, io.netty5.handler.codec.http.headers.HttpHeaders, org.springframework.lang.Nullable, org.springframework.util.Assert, .CollectionUtils, .MultiValueMap
MultiValueMap implementation for wrapping Netty HTTP headers.
Author
Violeta Georgieva
Since
6.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
Netty5HeadersAdapter.EntryIterator

private class
Netty5HeadersAdapter.HeaderEntry

private class
Netty5HeadersAdapter.HeaderNames

private class
Netty5HeadersAdapter.HeaderNamesIterator

Field Summary

Modifier and TypeField and Description
private final HttpHeaders
headers

Constructor Summary

AccessConstructor and Description
public
Netty5HeadersAdapter(HttpHeaders headers)

Create a new Netty5HeadersAdapter based on the given HttpHeaders.

Method Summary

Modifier and TypeMethod 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
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 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:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

headersback to summary
private final HttpHeaders headers

Constructor Detail

Netty5HeadersAdapterback to summary
public Netty5HeadersAdapter(HttpHeaders headers)

Create a new Netty5HeadersAdapter based on the given HttpHeaders.

Method Detail

addback 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
addAllback 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
addAllback 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
clearback 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
containsKeyback 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
containsValueback 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
entrySetback 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
getback 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
@Nullable
getFirstback 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
isEmptyback 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
keySetback 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
putback 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
@Nullable
@Override
putAllback 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
removeback 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
setback 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
setAllback 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
sizeback 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
toSingleValueMapback 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
toStringback 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
valuesback 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
org.springframework.http.support back to summary

private Class Netty5HeadersAdapter.EntryIterator

extends Object
implements Iterator<Map.Entry<String, List<String>>>
Class Inheritance
  • java.lang.Object
  • org.springframework.http.support.Netty5HeadersAdapter.EntryIterator
All Implemented Interfaces
java.util.Iterator

Field Summary

Modifier and TypeField and Description
private final Iterator<CharSequence>
names

Constructor Summary

AccessConstructor and Description
private
EntryIterator()

Method Summary

Modifier and TypeMethod 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.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

namesback to summary
private final Iterator<CharSequence> names

Constructor Detail

EntryIteratorback to summary
private EntryIterator()

Method Detail

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public Map.Entry<String, List<String>> next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

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

the next element in the iteration

Annotations
@Override
org.springframework.http.support back to summary

private Class Netty5HeadersAdapter.HeaderEntry

extends Object
implements Map.Entry<String, List<String>>
Class Inheritance
  • java.lang.Object
  • org.springframework.http.support.Netty5HeadersAdapter.HeaderEntry
All Implemented Interfaces
java.util.Map.Entry

Field Summary

Modifier and TypeField and Description
private final CharSequence
key

Constructor Summary

AccessConstructor and Description
pack-priv
HeaderEntry(CharSequence key)

Method Summary

Modifier and TypeMethod 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).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

keyback to summary
private final CharSequence key

Constructor Detail

HeaderEntryback to summary
pack-priv HeaderEntry(CharSequence key)

Method Detail

getKeyback to summary
public String getKey()

Implements java.util.Map.Entry.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

Returns:String

the key corresponding to this entry

Annotations
@Override
getValueback to summary
public List<String> getValue()

Implements java.util.Map.Entry.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:List<String>

the value corresponding to this entry

Annotations
@Override
setValueback to summary
public List<String> setValue(List<String> value)

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters
value:List<String>

new value to be stored in this entry

Returns:List<String>

old value corresponding to the entry

Annotations
@Override
org.springframework.http.support back to summary

private Class Netty5HeadersAdapter.HeaderNames

extends AbstractSet<String>
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
HeaderNames()

Method Summary

Modifier and TypeMethod and Description
public Iterator<String>
iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Returns an iterator over the elements in this set.

public int
size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Returns the number of elements in this set (its cardinality).

Inherited from java.util.AbstractSet:
equalshashCoderemoveAll

Constructor Detail

HeaderNamesback to summary
private HeaderNames()

Method Detail

iteratorback to summary
public Iterator<String> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<String>

an iterator over the elements in this set

Annotations
@Override
sizeback to summary
public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

Annotations
@Override
org.springframework.http.support back to summary

private final Class Netty5HeadersAdapter.HeaderNamesIterator

extends Object
implements Iterator<String>
Class Inheritance
  • java.lang.Object
  • org.springframework.http.support.Netty5HeadersAdapter.HeaderNamesIterator
All Implemented Interfaces
java.util.Iterator

Field Summary

Modifier and TypeField and Description
private CharSequence
currentName

private final Iterator<CharSequence>
iterator

Constructor Summary

AccessConstructor and Description
private
HeaderNamesIterator(Iterator<CharSequence> iterator)

Method Summary

Modifier and TypeMethod and Description
public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.

public String
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.

public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

currentNameback to summary
private CharSequence currentName
Annotations
@Nullable
iteratorback to summary
private final Iterator<CharSequence> iterator

Constructor Detail

HeaderNamesIteratorback to summary
private HeaderNamesIterator(Iterator<CharSequence> iterator)

Method Detail

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public String next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:String

the next element in the iteration

Annotations
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override