org.vertx.java.core

Interface MultiMap

All Superinterfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

All Known Implementing Classes:

CaseInsensitiveMultiMap, HttpHeadersAdapter

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

Method Summary

Methods

Modifier and Type	Method and Description
MultiMap	add(java.util.Map<java.lang.String,java.lang.String> headers) Adds all the entries from a Map to this
MultiMap	add(MultiMap headers) Adds all the entries from another MultiMap to this one
MultiMap	add(java.lang.String name, java.lang.Iterable<java.lang.String> values) Adds a new values under the specified name
MultiMap	add(java.lang.String name, java.lang.String value) Adds a new value with the specified name and value.
MultiMap	clear() Removes all
boolean	contains(java.lang.String name) Checks to see if there is a value with the specified name
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	entries() Returns all entries it contains.
java.lang.String	get(java.lang.String name) Returns the value of with the specified name.
java.util.List<java.lang.String>	getAll(java.lang.String name) Returns the values with the specified name
boolean	isEmpty() Return true if empty
java.util.Set<java.lang.String>	names() Gets a immutable Set of all names
MultiMap	remove(java.lang.String name) Removes the value with the given name
MultiMap	set(java.util.Map<java.lang.String,java.lang.String> headers) Cleans and set all values of the given instance
MultiMap	set(MultiMap headers) Cleans this instance.
MultiMap	set(java.lang.String name, java.lang.Iterable<java.lang.String> values) Sets values for the specified name.
MultiMap	set(java.lang.String name, java.lang.String value) Sets a value under the specified name.
int	size() Return the number of names.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

get

java.lang.String get(java.lang.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

java.util.List<java.lang.String> getAll(java.lang.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

entries

java.util.List<java.util.Map.Entry<java.lang.String,java.lang.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(java.lang.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

isEmpty

boolean isEmpty()

Return true if empty

names

java.util.Set<java.lang.String> names()

Gets a immutable Set of all names

Returns:

A Set of all names

add

MultiMap add(java.lang.String name,
           java.lang.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(java.lang.String name,
           java.lang.Iterable<java.lang.String> values)

Adds a new values under the specified name

Parameters:

name - The name being set

values - The values

Returns:

this

add

MultiMap add(MultiMap headers)

Adds all the entries from another MultiMap to this one

Returns:

this

add

MultiMap add(java.util.Map<java.lang.String,java.lang.String> headers)

Adds all the entries from a Map to this

Returns:

this

set

MultiMap set(java.lang.String name,
           java.lang.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(java.lang.String name,
           java.lang.Iterable<java.lang.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(MultiMap headers)

Cleans this instance.

Returns:

this

set

MultiMap set(java.util.Map<java.lang.String,java.lang.String> headers)

Cleans and set all values of the given instance

Returns:

this

remove

MultiMap remove(java.lang.String name)

Removes the value with the given name

Parameters:

name - The name of the value to remove

Returns:

this

clear

MultiMap clear()

Removes all

Returns:

this

size

int size()

Return the number of names.