Package io.vertx.reactivex.core
Class MultiMap
- java.lang.Object
-
- io.vertx.reactivex.core.MultiMap
-
public class MultiMap extends Object implements Iterable<Map.Entry<String,String>>
This class represents a MultiMap of String keys to a List of String values.It's useful in Vert.x to represent things in Vert.x like HTTP headers and HTTP parameters which allow multiple values for keys.
NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<MultiMap>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MultiMap
add(CharSequence name, CharSequence value)
Likeadd(java.lang.String, java.lang.String)
but acceptingCharSequence
as parametersMultiMap
add(CharSequence name, Iterable<CharSequence> values)
Likeadd(java.lang.String, java.lang.String)
but acceptingCharSequence
as parametersMultiMap
add(String name, Iterable<String> values)
Adds a new values under the specified nameMultiMap
add(String name, String value)
Adds a new value with the specified name and value.MultiMap
addAll(MultiMap map)
Adds all the entries from another MultiMap to this oneMultiMap
addAll(Map<String,String> headers)
Adds all the entries from a Map to thisstatic MultiMap
caseInsensitiveMultiMap()
Create a multi-map implementation with case insensitive keys, for instance it can be used to hold some HTTP headers.MultiMap
clear()
Removes allboolean
contains(CharSequence name)
Likecontains(java.lang.String)
but accepting aCharSequence
as a parameterboolean
contains(CharSequence name, CharSequence value, boolean caseInsensitive)
Likecontains(java.lang.String)
but acceptingCharSequence
parameters.boolean
contains(String name)
Checks to see if there is a value with the specified nameboolean
contains(String name, String value, boolean caseInsensitive)
Check if there is a header with the specifiedname
andvalue
.List<Map.Entry<String,String>>
entries()
Returns all entries in the multi-map.boolean
equals(Object o)
void
forEach(BiConsumer<String,String> action)
Allows iterating over the entries in the mapString
get(CharSequence name)
String
get(String name)
Returns the value of with the specified name.List<String>
getAll(CharSequence name)
LikegetAll(java.lang.String)
but accepting aCharSequence
as a parameterList<String>
getAll(String name)
Returns the values with the specified nameMultiMap
getDelegate()
int
hashCode()
boolean
isEmpty()
Return true if emptyIterator<Map.Entry<String,String>>
iterator()
Set<String>
names()
Gets a immutableSet
of all namesstatic MultiMap
newInstance(MultiMap arg)
MultiMap
remove(CharSequence name)
Likeremove(java.lang.String)
but acceptingCharSequence
as parametersMultiMap
remove(String name)
Removes the value with the given nameMultiMap
set(CharSequence name, CharSequence value)
Likeset(java.lang.String, java.lang.String)
but acceptingCharSequence
as parametersMultiMap
set(CharSequence name, Iterable<CharSequence> values)
Likeset(java.lang.String, java.lang.String)
but acceptingCharSequence
as parametersMultiMap
set(String name, Iterable<String> values)
Sets values for the specified name.MultiMap
set(String name, String value)
Sets avalue
under the specifiedname
.MultiMap
setAll(MultiMap map)
Cleans this instance.MultiMap
setAll(Map<String,String> headers)
Cleans and set all values of the given instanceint
size()
Return the number of keys.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
getDelegate
public MultiMap getDelegate()
-
caseInsensitiveMultiMap
public static MultiMap caseInsensitiveMultiMap()
Create a multi-map implementation with case insensitive keys, for instance it can be used to hold some HTTP headers.- Returns:
- the multi-map
-
get
public String get(String name)
Returns the value of with the specified name. If there are more than one values for the specified name, the first value is returned.- Parameters:
name
- The name of the header to search- Returns:
- The first header value or
null
if there is no such entry
-
getAll
public List<String> getAll(String name)
Returns the values with the specified name- Parameters:
name
- The name to search- Returns:
- A immutable
List
of values which will be empty if no values are found
-
contains
public boolean contains(String name)
Checks to see if there is a value with the specified name- Parameters:
name
- The name to search for- Returns:
- true if at least one entry is found
-
contains
public boolean contains(String name, String value, boolean caseInsensitive)
Check if there is a header with the specifiedname
andvalue
. IfcaseInsensitive
istrue
,value
is compared in a case-insensitive way.- Parameters:
name
- the name to search forvalue
- the value to search forcaseInsensitive
-- Returns:
true
if at least one entry is found
-
isEmpty
public boolean isEmpty()
Return true if empty- Returns:
-
add
public MultiMap add(String name, String value)
Adds a new value with the specified name and value.- Parameters:
name
- The namevalue
- The value being added- Returns:
- a reference to this, so the API can be used fluently
-
addAll
public MultiMap addAll(MultiMap map)
Adds all the entries from another MultiMap to this one- Parameters:
map
-- Returns:
- a reference to this, so the API can be used fluently
-
set
public MultiMap set(String name, String value)
Sets avalue
under the specifiedname
.If there is an existing header with the same name, it is removed. Setting a
null
value removes the entry.- Parameters:
name
- The namevalue
- The value- Returns:
- a reference to this, so the API can be used fluently
-
setAll
public MultiMap setAll(MultiMap map)
Cleans this instance.- Parameters:
map
-- Returns:
- a reference to this, so the API can be used fluently
-
remove
public MultiMap remove(String name)
Removes the value with the given name- Parameters:
name
- The name of the value to remove- Returns:
- a reference to this, so the API can be used fluently
-
clear
public MultiMap clear()
Removes all- Returns:
- a reference to this, so the API can be used fluently
-
size
public int size()
Return the number of keys.- Returns:
-
get
public String get(CharSequence name)
-
getAll
public List<String> getAll(CharSequence name)
LikegetAll(java.lang.String)
but accepting aCharSequence
as a parameter- Parameters:
name
-- Returns:
-
forEach
public void forEach(BiConsumer<String,String> action)
Allows iterating over the entries in the map- Parameters:
action
-
-
entries
public List<Map.Entry<String,String>> entries()
Returns all entries in the multi-map.- Returns:
- A immutable
List
of the name-value entries, which will be empty if no pairs are found
-
contains
public boolean contains(CharSequence name)
Likecontains(java.lang.String)
but accepting aCharSequence
as a parameter- Parameters:
name
-- Returns:
-
contains
public boolean contains(CharSequence name, CharSequence value, boolean caseInsensitive)
Likecontains(java.lang.String)
but acceptingCharSequence
parameters.- Parameters:
name
-value
-caseInsensitive
-- Returns:
-
add
public MultiMap add(CharSequence name, CharSequence value)
Likeadd(java.lang.String, java.lang.String)
but acceptingCharSequence
as parameters- Parameters:
name
-value
-- Returns:
-
add
public MultiMap add(String name, Iterable<String> values)
Adds a new values under the specified name- Parameters:
name
- The name being setvalues
- The values- Returns:
- a reference to this, so the API can be used fluently
-
add
public MultiMap add(CharSequence name, Iterable<CharSequence> values)
Likeadd(java.lang.String, java.lang.String)
but acceptingCharSequence
as parameters- Parameters:
name
-values
-- Returns:
-
addAll
public MultiMap addAll(Map<String,String> headers)
Adds all the entries from a Map to this- Parameters:
headers
-- Returns:
- a reference to this, so the API can be used fluently
-
set
public MultiMap set(CharSequence name, CharSequence value)
Likeset(java.lang.String, java.lang.String)
but acceptingCharSequence
as parameters- Parameters:
name
-value
-- Returns:
-
set
public MultiMap set(String name, Iterable<String> values)
Sets values for the specified name.- Parameters:
name
- The name of the headers being setvalues
- The values of the headers being set- Returns:
- a reference to this, so the API can be used fluently
-
set
public MultiMap set(CharSequence name, Iterable<CharSequence> values)
Likeset(java.lang.String, java.lang.String)
but acceptingCharSequence
as parameters- Parameters:
name
-values
-- Returns:
-
setAll
public MultiMap setAll(Map<String,String> headers)
Cleans and set all values of the given instance- Parameters:
headers
-- Returns:
- a reference to this, so the API can be used fluently
-
remove
public MultiMap remove(CharSequence name)
Likeremove(java.lang.String)
but acceptingCharSequence
as parameters- Parameters:
name
-- Returns:
-
-