Vert.x 4.5.13 · io.vertx.core.MultiMap · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public MultiMap	Returns: a reference to this, so the API can be used fluently add(String The name name, String The value being added value) Adds a new value with the specified name and value.
public MultiMap	add(CharSequence name, CharSequence value) Like `add(String, String)` but accepting `CharSequence` as parameters
public MultiMap	Returns: a reference to this, so the API can be used fluently add(String The name being set name, Iterable<String> The values values) Adds a new values under the specified name
public MultiMap	add(CharSequence name, Iterable<CharSequence> values) Like `add(String, Iterable)` but accepting `CharSequence` as parameters
public MultiMap	Returns: a reference to this, so the API can be used fluently addAll(MultiMap map) Adds all the entries from another MultiMap to this one
public MultiMap	Returns: a reference to this, so the API can be used fluently addAll(Map<String, String> headers) Adds all the entries from a Map to this
public static MultiMap	Returns: the multi-map caseInsensitiveMultiMap() Create a multi-map implementation with case insensitive keys, for instance it can be used to hold some HTTP headers.
public MultiMap	Returns: a reference to this, so the API can be used fluently clear() Removes all
public boolean	Returns: true if at least one entry is found contains(String The name to search for name) Checks to see if there is a value with the specified name
public boolean	contains(CharSequence name) Like `contains(String)` but accepting a `CharSequence` as a parameter
public default boolean	Returns: `true` if at least one entry is found contains(String the name to search for name, String the value to search for value, boolean caseInsensitive) Check if there is a header with the specified `name` and `value`.
public default boolean	contains(CharSequence name, CharSequence value, boolean caseInsensitive) Like `contains(String, String, boolean)` but accepting `CharSequence` parameters.
public default List<Map.Entry<String, String>>	Returns: A immutable `java.util.List` of the name-value entries, which will be empty if no pairs are found entries() Returns all entries in the multi-map.
public default void	forEach(BiConsumer<String, String> action) Allows iterating over the entries in the map
public String	get(CharSequence name)
public @Nullable String	Returns: The first header value or `null` if there is no such entry get(String The name of the header to search name) Returns the value of with the specified name.
public List<String>	Returns: A immutable `java.util.List` of values which will be empty if no values are found getAll(String The name to search name) Returns the values with the specified name
public List<String>	getAll(CharSequence name) Like `getAll(String)` but accepting a `CharSequence` as a parameter
public boolean	isEmpty() Return true if empty
public Set<String>	Returns: A `java.util.Set` of all names names() Gets a immutable `java.util.Set` of all names
public MultiMap	Returns: a reference to this, so the API can be used fluently remove(String The name of the value to remove name) Removes the value with the given name
public MultiMap	remove(CharSequence name) Like `remove(String)` but accepting `CharSequence` as parameters
public MultiMap	Returns: a reference to this, so the API can be used fluently set(String The name name, String The value value) Sets a `value` under the specified `name`.
public MultiMap	set(CharSequence name, CharSequence value) Like `set(String, String)` but accepting `CharSequence` as parameters
public MultiMap	Returns: a reference to this, so the API can be used fluently set(String The name of the headers being set name, Iterable<String> The values of the headers being set values) Sets values for the specified name.
public MultiMap	set(CharSequence name, Iterable<CharSequence> values) Like `set(String, Iterable)` but accepting `CharSequence` as parameters
public MultiMap	Returns: a reference to this, so the API can be used fluently setAll(MultiMap map) Cleans this instance.
public MultiMap	Returns: a reference to this, so the API can be used fluently setAll(Map<String, String> headers) Cleans and set all values of the given instance
public int	size() Return the number of keys.

Inherited from java.lang.Iterable:: forEach iterator spliterator

Method Detail

add	back to summary
public MultiMap add(String name, String value) Adds a new value with the specified name and value. Parameters name:String The name value:String The value being added Returns:MultiMap a reference to this, so the API can be used fluently Annotations @Fluent

add

back to summary

public MultiMap add(String name, String value)

Adds a new value with the specified name and value.

Parameters

name:String: The name
value:String: The value being added

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@Fluent

add back to summary

add	back to summary
public MultiMap add(CharSequence name, CharSequence value) Like `add(String, String)` but accepting `CharSequence` as parameters Annotations @GenIgnore:permitted-type @Fluent

public MultiMap add(CharSequence name, CharSequence value)

Like add(String, String) but accepting CharSequence as parameters

Annotations

@GenIgnore:permitted-type
@Fluent

add	back to summary
public MultiMap add(String name, Iterable<String> values) Adds a new values under the specified name Parameters name:String The name being set values:Iterable<String> The values Returns:MultiMap a reference to this, so the API can be used fluently Annotations @GenIgnore:permitted-type @Fluent

add

back to summary

public MultiMap add(String name, Iterable<String> values)

Adds a new values under the specified name

Parameters

name:String: The name being set
values:Iterable<String>: The values

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@GenIgnore:permitted-type
@Fluent

add back to summary

add	back to summary
public MultiMap add(CharSequence name, Iterable<CharSequence> values) Like `add(String, Iterable)` but accepting `CharSequence` as parameters Annotations @GenIgnore:permitted-type @Fluent

public MultiMap add(CharSequence name, Iterable<CharSequence> values)

Like add(String, Iterable) but accepting CharSequence as parameters

Annotations

@GenIgnore:permitted-type
@Fluent

addAll	back to summary
public MultiMap addAll(MultiMap map) Adds all the entries from another MultiMap to this one Returns:MultiMap a reference to this, so the API can be used fluently Annotations @Fluent

addAll

back to summary

public MultiMap addAll(MultiMap map)

Adds all the entries from another MultiMap to this one

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@Fluent

addAll	back to summary
public MultiMap addAll(Map<String, String> headers) Adds all the entries from a Map to this Returns:MultiMap a reference to this, so the API can be used fluently Annotations @GenIgnore:permitted-type @Fluent

addAll

back to summary

public MultiMap addAll(Map<String, String> headers)

Adds all the entries from a Map to this

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@GenIgnore:permitted-type
@Fluent

caseInsensitiveMultiMap	back to summary
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:MultiMap the multi-map

caseInsensitiveMultiMap

back to summary

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:MultiMap: the multi-map

clear	back to summary
public MultiMap clear() Removes all Returns:MultiMap a reference to this, so the API can be used fluently Annotations @Fluent

clear

back to summary

public MultiMap clear()

Removes all

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@Fluent

contains	back to summary
public boolean contains(String name) Checks to see if there is a value with the specified name Parameters name:String The name to search for Returns:boolean true if at least one entry is found

contains

back to summary

public boolean contains(String name)

Checks to see if there is a value with the specified name

Parameters

name:String: The name to search for

Returns:boolean

true if at least one entry is found

contains back to summary

contains	back to summary
public boolean contains(CharSequence name) Like `contains(String)` but accepting a `CharSequence` as a parameter Annotations @GenIgnore:permitted-type

public boolean contains(CharSequence name)

Like contains(String) but accepting a CharSequence as a parameter

Annotations

@GenIgnore:permitted-type

contains back to summary

contains	back to summary
public default boolean contains(String name, String value, boolean caseInsensitive) Check if there is a header with the specified `name` and `value`. If `caseInsensitive` is `true`, `value` is compared in a case-insensitive way. Parameters name:String the name to search for value:String the value to search for Returns:boolean `true` if at least one entry is found

public default boolean contains(String name, String value, boolean caseInsensitive)

Check if there is a header with the specified name and value. If caseInsensitive is true, value is compared in a case-insensitive way.

Parameters

name:String: the name to search for
value:String: the value to search for

Returns:boolean

true if at least one entry is found

contains back to summary

contains	back to summary
public default boolean contains(CharSequence name, CharSequence value, boolean caseInsensitive) Like `contains(String, String, boolean)` but accepting `CharSequence` parameters. Annotations @GenIgnore:permitted-type

public default boolean contains(CharSequence name, CharSequence value, boolean caseInsensitive)

Like contains(String, String, boolean) but accepting CharSequence parameters.

Annotations

@GenIgnore:permitted-type

entries back to summary

entries	back to summary
public default List<Map.Entry<String, String>> entries() Returns all entries in the multi-map. Returns:List<Map.Entry<String, String>> A immutable `java.util.List` of the name-value entries, which will be empty if no pairs are found Annotations @GenIgnore:permitted-type

public default List<Map.Entry<String, String>> entries()

Returns all entries in the multi-map.

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

A immutable java.util.List of the name-value entries, which will be empty if no pairs are found

Annotations

@GenIgnore:permitted-type

forEach	back to summary
public default void forEach(BiConsumer<String, String> action) Allows iterating over the entries in the map Annotations @GenIgnore:permitted-type

forEach

back to summary

public default void forEach(BiConsumer<String, String> action)

Allows iterating over the entries in the map

Annotations

@GenIgnore:permitted-type

get	back to summary
public String get(CharSequence name) Annotations @GenIgnore:permitted-type

get back to summary

get	back to summary
public @Nullable 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:String The name of the header to search Returns:@Nullable String The first header value or `null` if there is no such entry

public @Nullable 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:String: The name of the header to search

Returns:@Nullable String

The first header value or null if there is no such entry

getAll back to summary

getAll	back to summary
public List<String> getAll(String name) Returns the values with the specified name Parameters name:String The name to search Returns:List<String> A immutable `java.util.List` of values which will be empty if no values are found

public List<String> getAll(String name)

Returns the values with the specified name

Parameters

name:String: The name to search

Returns:List<String>

A immutable java.util.List of values which will be empty if no values are found

getAll back to summary

getAll	back to summary
public List<String> getAll(CharSequence name) Like `getAll(String)` but accepting a `CharSequence` as a parameter Annotations @GenIgnore:permitted-type

public List<String> getAll(CharSequence name)

Like getAll(String) but accepting a CharSequence as a parameter

Annotations

@GenIgnore:permitted-type

isEmpty	back to summary
public boolean isEmpty() Return true if empty

names back to summary

names	back to summary
public Set<String> names() Gets a immutable `java.util.Set` of all names Returns:Set<String> A `java.util.Set` of all names

public Set<String> names()

Gets a immutable java.util.Set of all names

Returns:Set<String>: A java.util.Set of all names

remove	back to summary
public MultiMap remove(String name) Removes the value with the given name Parameters name:String The name of the value to remove Returns:MultiMap a reference to this, so the API can be used fluently Annotations @Fluent

remove

back to summary

public MultiMap remove(String name)

Removes the value with the given name

Parameters

name:String: The name of the value to remove

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@Fluent

remove back to summary

remove	back to summary
public MultiMap remove(CharSequence name) Like `remove(String)` but accepting `CharSequence` as parameters Annotations @GenIgnore:permitted-type @Fluent

public MultiMap remove(CharSequence name)

Like remove(String) but accepting CharSequence as parameters

Annotations

@GenIgnore:permitted-type
@Fluent

set back to summary

set	back to summary
public MultiMap set(String name, String value) Sets a `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. Parameters name:String The name value:String The value Returns:MultiMap a reference to this, so the API can be used fluently Annotations @Fluent

public MultiMap set(String name, String value)

Sets a 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.

Parameters

name:String: The name
value:String: The value

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@Fluent

set back to summary

set	back to summary
public MultiMap set(CharSequence name, CharSequence value) Like `set(String, String)` but accepting `CharSequence` as parameters Annotations @GenIgnore:permitted-type @Fluent

public MultiMap set(CharSequence name, CharSequence value)

Like set(String, String) but accepting CharSequence as parameters

Annotations

@GenIgnore:permitted-type
@Fluent

set	back to summary
public MultiMap set(String name, Iterable<String> values) Sets values for the specified name. Parameters name:String The name of the headers being set values:Iterable<String> The values of the headers being set Returns:MultiMap a reference to this, so the API can be used fluently Annotations @GenIgnore:permitted-type @Fluent

set

back to summary

public MultiMap set(String name, Iterable<String> values)

Sets values for the specified name.

Parameters

name:String: The name of the headers being set
values:Iterable<String>: The values of the headers being set

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@GenIgnore:permitted-type
@Fluent

set back to summary

set	back to summary
public MultiMap set(CharSequence name, Iterable<CharSequence> values) Like `set(String, Iterable)` but accepting `CharSequence` as parameters Annotations @GenIgnore:permitted-type @Fluent

public MultiMap set(CharSequence name, Iterable<CharSequence> values)

Like set(String, Iterable) but accepting CharSequence as parameters

Annotations

@GenIgnore:permitted-type
@Fluent

setAll	back to summary
public MultiMap setAll(MultiMap map) Cleans this instance. Returns:MultiMap a reference to this, so the API can be used fluently Annotations @Fluent

setAll

back to summary

public MultiMap setAll(MultiMap map)

Cleans this instance.

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@Fluent

setAll	back to summary
public MultiMap setAll(Map<String, String> headers) Cleans and set all values of the given instance Returns:MultiMap a reference to this, so the API can be used fluently Annotations @GenIgnore:permitted-type @Fluent

setAll

back to summary

public MultiMap setAll(Map<String, String> headers)

Cleans and set all values of the given instance

Returns:MultiMap

a reference to this, so the API can be used fluently

Annotations

@GenIgnore:permitted-type
@Fluent

size	back to summary
public int size() Return the number of keys.

public Interface MultiMap

Method Summary

Method Detail