public interface MultiMap extends Iterable<Map.Entry<String,String>>
It's useful in Vert.x to represent things in Vert.x like HTTP headers and HTTP parameters which allow multiple values for keys.
Modifier and Type | Method and Description |
---|---|
MultiMap |
add(CharSequence name,
CharSequence value)
Like
add(String, String) but accepting CharSequence as parameters |
MultiMap |
add(CharSequence name,
Iterable<CharSequence> values)
Like
add(String, Iterable) but accepting CharSequence as parameters |
MultiMap |
add(String name,
Iterable<String> values)
Adds a new values under the specified name
|
MultiMap |
add(String name,
String value)
Adds a new value with the specified name and value.
|
MultiMap |
addAll(Map<String,String> headers)
Adds all the entries from a Map to this
|
MultiMap |
addAll(MultiMap map)
Adds all the entries from another MultiMap to this one
|
static 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 all
|
boolean |
contains(CharSequence name)
Like
contains(String) but accepting a CharSequence as a parameter |
default boolean |
contains(CharSequence name,
CharSequence value,
boolean caseInsensitive)
Like
contains(String, String, boolean) but accepting CharSequence parameters. |
boolean |
contains(String name)
Checks to see if there is a value with the specified name
|
default boolean |
contains(String name,
String value,
boolean caseInsensitive)
Check if there is a header with the specified
name and value . |
default List<Map.Entry<String,String>> |
entries()
Returns all entries in the multi-map.
|
default void |
forEach(java.util.function.BiConsumer<String,String> action)
Allows iterating over the entries in the map
|
String |
get(CharSequence name) |
String |
get(String name)
Returns the value of with the specified name.
|
List<String> |
getAll(CharSequence name)
Like
getAll(String) but accepting a CharSequence as a parameter |
List<String> |
getAll(String name)
Returns the values with the specified name
|
boolean |
isEmpty()
Return true if empty
|
Set<String> |
names()
Gets a immutable
Set of all names |
MultiMap |
remove(CharSequence name)
Like
remove(String) but accepting CharSequence as parameters |
MultiMap |
remove(String name)
Removes the value with the given name
|
MultiMap |
set(CharSequence name,
CharSequence value)
Like
set(String, String) but accepting CharSequence as parameters |
MultiMap |
set(CharSequence name,
Iterable<CharSequence> values)
Like
set(String, Iterable) but accepting CharSequence as parameters |
MultiMap |
set(String name,
Iterable<String> values)
Sets values for the specified name.
|
MultiMap |
set(String name,
String value)
Sets a
value under the specified name . |
MultiMap |
setAll(Map<String,String> headers)
Cleans and set all values of the given instance
|
MultiMap |
setAll(MultiMap map)
Cleans this instance.
|
int |
size()
Return the number of keys.
|
forEach, iterator, spliterator
static MultiMap caseInsensitiveMultiMap()
String get(CharSequence name)
String get(String name)
name
- The name of the header to searchnull
if there is no such entryList<String> getAll(String name)
name
- The name to searchList
of values which will be empty if no values
are foundList<String> getAll(CharSequence name)
getAll(String)
but accepting a CharSequence
as a parameterdefault void forEach(java.util.function.BiConsumer<String,String> action)
default List<Map.Entry<String,String>> entries()
List
of the name-value entries, which will be
empty if no pairs are foundboolean contains(String name)
name
- The name to search forboolean contains(CharSequence name)
contains(String)
but accepting a CharSequence
as a parameterdefault boolean contains(String name, String value, boolean caseInsensitive)
name
and value
.
If caseInsensitive
is true
, value
is compared in a case-insensitive way.name
- the name to search forvalue
- the value to search fortrue
if at least one entry is founddefault boolean contains(CharSequence name, CharSequence value, boolean caseInsensitive)
contains(String, String, boolean)
but accepting CharSequence
parameters.boolean isEmpty()
MultiMap add(String name, String value)
name
- The namevalue
- The value being addedMultiMap add(CharSequence name, CharSequence value)
add(String, String)
but accepting CharSequence
as parametersMultiMap add(String name, Iterable<String> values)
name
- The name being setvalues
- The valuesMultiMap add(CharSequence name, Iterable<CharSequence> values)
add(String, Iterable)
but accepting CharSequence
as parametersMultiMap addAll(MultiMap map)
MultiMap addAll(Map<String,String> headers)
MultiMap set(String name, String value)
value
under the specified name
.
If there is an existing header with the same name, it is removed. Setting a null
value removes the entry.
name
- The namevalue
- The valueMultiMap set(CharSequence name, CharSequence value)
set(String, String)
but accepting CharSequence
as parametersMultiMap set(String name, Iterable<String> values)
name
- The name of the headers being setvalues
- The values of the headers being setMultiMap set(CharSequence name, Iterable<CharSequence> values)
set(String, Iterable)
but accepting CharSequence
as parametersMultiMap setAll(MultiMap map)
MultiMap setAll(Map<String,String> headers)
MultiMap remove(String name)
name
- The name of the value to removeMultiMap remove(CharSequence name)
remove(String)
but accepting CharSequence
as parametersMultiMap clear()
int size()
Copyright © 2023 Eclipse. All rights reserved.