io.vertx.core

Interface MultiMap

All Superinterfaces:

Iterable<Map.Entry<String,String>>

All Known Implementing Classes:

CaseInsensitiveHeaders, HeadersAdaptor

public interface MultiMap
extends Iterable<Map.Entry<String,String>>

Author:

<a href="mailto:[email protected]">Norman Maurer</a>, <a href="http://tfox.org">Tim Fox</a>

Method Summary

Modifier and Type	Method and Description
MultiMap	add(CharSequence name, CharSequence value)
MultiMap	add(CharSequence name, Iterable<CharSequence> values)
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
MultiMap	clear() Removes all
boolean	contains(CharSequence name)
boolean	contains(String name) Checks to see if there is a value with the specified name
List<Map.Entry<String,String>>	entries() Returns all entries it contains.
String	get(CharSequence name)
String	get(String name) Returns the value of with the specified name.
List<String>	getAll(CharSequence name)
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)
MultiMap	remove(String name) Removes the value with the given name
MultiMap	set(CharSequence name, CharSequence value)
MultiMap	set(CharSequence name, Iterable<CharSequence> values)
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 names.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

String get(CharSequence name)

get

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

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

getAll

List<String> getAll(CharSequence name)

entries

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

Returns all entries it contains.

Returns:

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

contains

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

boolean contains(CharSequence name)

isEmpty

boolean isEmpty()

Return true if empty

names

Set<String> names()

Gets a immutable Set of all names

Returns:

A Set of all names

add

MultiMap add(String name,
             String value)

Adds a new value with the specified name and value.

Parameters:

name - The name

value - The value being added

Returns:

this

add

MultiMap add(CharSequence name,
             CharSequence value)

add

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

Adds a new values under the specified name

Parameters:

name - The name being set

values - The values

Returns:

this

add

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

addAll

MultiMap addAll(MultiMap map)

Adds all the entries from another MultiMap to this one

Returns:

this

addAll

MultiMap addAll(Map<String,String> headers)

Adds all the entries from a Map to this

Returns:

this

set

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.

Parameters:

name - The name

value - The value

Returns:

this

set

MultiMap set(CharSequence name,
             CharSequence value)

set

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

Sets values for the specified name.

Parameters:

name - The name of the headers being set

values - The values of the headers being set

Returns:

this

set

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

setAll

MultiMap setAll(MultiMap map)

Cleans this instance.

Returns:

this

setAll

MultiMap setAll(Map<String,String> headers)

Cleans and set all values of the given instance

Returns:

this

remove

MultiMap remove(String name)

Removes the value with the given name

Parameters:

name - The name of the value to remove

Returns:

this

remove

MultiMap remove(CharSequence name)

clear

MultiMap clear()

Removes all

Returns:

this

size

int size()

Return the number of names.