io.vertx.core.http.impl.headers

Class HeadersMultiMap

java.lang.Object

io.netty.handler.codec.http.HttpHeaders

io.vertx.core.http.impl.headers.HeadersMultiMap

All Implemented Interfaces:

MultiMap, Iterable<Map.Entry<String,String>>

public final class HeadersMultiMap
extends io.netty.handler.codec.http.HttpHeaders
implements MultiMap

A case-insensitive MultiMap implementation that extends Netty HttpHeaders for convenience.

Author:

Julien Viet

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.http.HttpHeaders

io.netty.handler.codec.http.HttpHeaders.Names, io.netty.handler.codec.http.HttpHeaders.Values

Field Summary

Fields inherited from class io.netty.handler.codec.http.HttpHeaders

EMPTY_HEADERS

Constructor Summary

Constructors

Constructor and Description
HeadersMultiMap()
HeadersMultiMap(BiConsumer<CharSequence,CharSequence> validator)

Method Summary

Modifier and Type	Method and Description
HeadersMultiMap	add(CharSequence name, CharSequence value) Like MultiMap.add(String, String) but accepting CharSequence as parameters
HeadersMultiMap	add(CharSequence name, Iterable values) Like MultiMap.add(String, Iterable) but accepting CharSequence as parameters
HeadersMultiMap	add(CharSequence name, Object value)
HeadersMultiMap	add(String name, Iterable values) Adds a new values under the specified name
io.netty.handler.codec.http.HttpHeaders	add(String name, Object value)
HeadersMultiMap	add(String name, String strVal) Adds a new value with the specified name and value.
MultiMap	addAll(Map<String,String> map) Adds all the entries from a Map to this
MultiMap	addAll(MultiMap headers) Adds all the entries from another MultiMap to this one
io.netty.handler.codec.http.HttpHeaders	addInt(CharSequence name, int value)
io.netty.handler.codec.http.HttpHeaders	addShort(CharSequence name, short value)
HeadersMultiMap	clear() Removes all
boolean	contains(CharSequence name) Like MultiMap.contains(String) but accepting a CharSequence as a parameter
boolean	contains(CharSequence name, CharSequence value, boolean ignoreCase) Like MultiMap.contains(String, String, boolean) but accepting CharSequence parameters.
boolean	contains(String name) Checks to see if there is a value with the specified name
boolean	contains(String name, String value, boolean ignoreCase) Check if there is a header with the specified name and value.
void	encode(io.netty.buffer.ByteBuf buf)
List<Map.Entry<String,String>>	entries() Returns all entries in the multi-map.
void	forEach(Consumer<? super Map.Entry<String,String>> action)
String	get(CharSequence name)
String	get(String name) Returns the value of with the specified name.
List<String>	getAll(CharSequence name) Like MultiMap.getAll(String) but accepting a CharSequence as a parameter
List<String>	getAll(String name) Returns the values with the specified name
Integer	getInt(CharSequence name)
int	getInt(CharSequence name, int defaultValue)
Short	getShort(CharSequence name)
short	getShort(CharSequence name, short defaultValue)
Long	getTimeMillis(CharSequence name)
long	getTimeMillis(CharSequence name, long defaultValue)
static HeadersMultiMap	headers()
static HeadersMultiMap	httpHeaders()
boolean	isEmpty() Return true if empty
Iterator<Map.Entry<String,String>>	iterator()
Iterator<Map.Entry<CharSequence,CharSequence>>	iteratorCharSequence()
Set<String>	names() Gets a immutable Set of all names
HeadersMultiMap	remove(CharSequence name) Like MultiMap.remove(String) but accepting CharSequence as parameters
HeadersMultiMap	remove(String name) Removes the value with the given name
HeadersMultiMap	set(CharSequence name, CharSequence value) Like MultiMap.set(String, String) but accepting CharSequence as parameters
HeadersMultiMap	set(CharSequence name, Iterable values) Like MultiMap.set(String, Iterable) but accepting CharSequence as parameters
HeadersMultiMap	set(CharSequence name, Object value)
HeadersMultiMap	set(String name, Iterable values) Sets values for the specified name.
HeadersMultiMap	set(String name, Object value)
HeadersMultiMap	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 headers) Cleans this instance.
io.netty.handler.codec.http.HttpHeaders	setInt(CharSequence name, int value)
io.netty.handler.codec.http.HttpHeaders	setShort(CharSequence name, short value)
int	size() Return the number of keys.
String	toString()

Methods inherited from class io.netty.handler.codec.http.HttpHeaders

add, addDateHeader, addDateHeader, addHeader, addHeader, addIntHeader, addIntHeader, clearHeaders, containsValue, copy, encodeAscii, equalsIgnoreCase, get, getAllAsString, getAsString, getContentLength, getContentLength, getDate, getDate, getDateHeader, getDateHeader, getDateHeader, getDateHeader, getHeader, getHeader, getHeader, getHeader, getHost, getHost, getIntHeader, getIntHeader, getIntHeader, getIntHeader, is100ContinueExpected, isContentLengthSet, isKeepAlive, isTransferEncodingChunked, iteratorAsString, newEntity, removeHeader, removeHeader, removeTransferEncodingChunked, set, set100ContinueExpected, set100ContinueExpected, setAll, setContentLength, setDate, setDateHeader, setDateHeader, setDateHeader, setDateHeader, setHeader, setHeader, setHeader, setHeader, setHost, setHost, setIntHeader, setIntHeader, setIntHeader, setIntHeader, setKeepAlive, setTransferEncodingChunked, valueCharSequenceIterator, valueStringIterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.core.MultiMap

caseInsensitiveMultiMap

Methods inherited from interface java.lang.Iterable

spliterator

Constructor Detail

HeadersMultiMap

public HeadersMultiMap()

HeadersMultiMap

public HeadersMultiMap(BiConsumer<CharSequence,CharSequence> validator)

Method Detail

httpHeaders

public static HeadersMultiMap httpHeaders()

Returns:

a case insensitive multi-map suited for HTTP header validation

headers

public static HeadersMultiMap headers()

Returns:

a all-purpose case insensitive multi-map that does not perform validation

setAll

public MultiMap setAll(MultiMap headers)

Description copied from interface: MultiMap

Cleans this instance.

Specified by:

setAll in interface MultiMap

Returns:

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

setAll

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

Description copied from interface: MultiMap

Cleans and set all values of the given instance

Specified by:

setAll in interface MultiMap

Returns:

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

size

public int size()

Description copied from interface: MultiMap

Return the number of keys.

Specified by:

size in interface MultiMap

Specified by:

size in class io.netty.handler.codec.http.HttpHeaders

add

public HeadersMultiMap add(CharSequence name,
                           CharSequence value)

Description copied from interface: MultiMap

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

Specified by:

add in interface MultiMap

add

public HeadersMultiMap add(CharSequence name,
                           Object value)

Overrides:

add in class io.netty.handler.codec.http.HttpHeaders

add

public io.netty.handler.codec.http.HttpHeaders add(String name,
                                                   Object value)

Specified by:

add in class io.netty.handler.codec.http.HttpHeaders

add

public HeadersMultiMap add(String name,
                           String strVal)

Description copied from interface: MultiMap

Adds a new value with the specified name and value.

Specified by:

add in interface MultiMap

Parameters:

name - The name

strVal - The value being added

Returns:

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

add

public HeadersMultiMap add(CharSequence name,
                           Iterable values)

Description copied from interface: MultiMap

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

Specified by:

add in interface MultiMap

Overrides:

add in class io.netty.handler.codec.http.HttpHeaders

add

public HeadersMultiMap add(String name,
                           Iterable values)

Description copied from interface: MultiMap

Adds a new values under the specified name

Specified by:

add in interface MultiMap

Specified by:

add in class io.netty.handler.codec.http.HttpHeaders

Parameters:

name - The name being set

values - The values

Returns:

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

addAll

public MultiMap addAll(MultiMap headers)

Description copied from interface: MultiMap

Adds all the entries from another MultiMap to this one

Specified by:

addAll in interface MultiMap

Returns:

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

addAll

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

Description copied from interface: MultiMap

Adds all the entries from a Map to this

Specified by:

addAll in interface MultiMap

Returns:

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

remove

public HeadersMultiMap remove(CharSequence name)

Description copied from interface: MultiMap

Like MultiMap.remove(String) but accepting CharSequence as parameters

Specified by:

remove in interface MultiMap

Overrides:

remove in class io.netty.handler.codec.http.HttpHeaders

remove

public HeadersMultiMap remove(String name)

Description copied from interface: MultiMap

Removes the value with the given name

Specified by:

remove in interface MultiMap

Specified by:

remove in class io.netty.handler.codec.http.HttpHeaders

Parameters:

name - The name of the value to remove

Returns:

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

set

public HeadersMultiMap set(CharSequence name,
                           CharSequence value)

Description copied from interface: MultiMap

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

Specified by:

set in interface MultiMap

set

public HeadersMultiMap set(String name,
                           String value)

Description copied from interface: MultiMap

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.

Specified by:

set in interface MultiMap

Parameters:

name - The name

value - The value

Returns:

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

set

public HeadersMultiMap set(String name,
                           Object value)

Specified by:

set in class io.netty.handler.codec.http.HttpHeaders

set

public HeadersMultiMap set(CharSequence name,
                           Object value)

Overrides:

set in class io.netty.handler.codec.http.HttpHeaders

set

public HeadersMultiMap set(CharSequence name,
                           Iterable values)

Description copied from interface: MultiMap

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

Specified by:

set in interface MultiMap

Overrides:

set in class io.netty.handler.codec.http.HttpHeaders

set

public HeadersMultiMap set(String name,
                           Iterable values)

Description copied from interface: MultiMap

Sets values for the specified name.

Specified by:

set in interface MultiMap

Specified by:

set in class io.netty.handler.codec.http.HttpHeaders

Parameters:

name - The name of the headers being set

values - The values of the headers being set

Returns:

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

contains

public boolean contains(CharSequence name,
                        CharSequence value,
                        boolean ignoreCase)

Description copied from interface: MultiMap

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

Specified by:

contains in interface MultiMap

Overrides:

contains in class io.netty.handler.codec.http.HttpHeaders

contains

public boolean contains(String name,
                        String value,
                        boolean ignoreCase)

Description copied from interface: MultiMap

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

Specified by:

contains in interface MultiMap

Overrides:

contains in class io.netty.handler.codec.http.HttpHeaders

Parameters:

name - the name to search for

value - the value to search for

Returns:

true if at least one entry is found

contains

public boolean contains(CharSequence name)

Description copied from interface: MultiMap

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

Specified by:

contains in interface MultiMap

Overrides:

contains in class io.netty.handler.codec.http.HttpHeaders

contains

public boolean contains(String name)

Description copied from interface: MultiMap

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

Specified by:

contains in interface MultiMap

Specified by:

contains in class io.netty.handler.codec.http.HttpHeaders

Parameters:

name - The name to search for

Returns:

true if at least one entry is found

get

public String get(CharSequence name)

Specified by:

get in interface MultiMap

Overrides:

get in class io.netty.handler.codec.http.HttpHeaders

get

public String get(String name)

Description copied from interface: MultiMap

Returns the value of with the specified name. If there are more than one values for the specified name, the first value is returned.

Specified by:

get in interface MultiMap

Specified by:

get in class io.netty.handler.codec.http.HttpHeaders

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(CharSequence name)

Description copied from interface: MultiMap

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

Specified by:

getAll in interface MultiMap

Overrides:

getAll in class io.netty.handler.codec.http.HttpHeaders

getAll

public List<String> getAll(String name)

Description copied from interface: MultiMap

Returns the values with the specified name

Specified by:

getAll in interface MultiMap

Specified by:

getAll in class io.netty.handler.codec.http.HttpHeaders

Parameters:

name - The name to search

Returns:

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

forEach

public void forEach(Consumer<? super Map.Entry<String,String>> action)

Specified by:

forEach in interface Iterable<Map.Entry<String,String>>

entries

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

Description copied from interface: MultiMap

Returns all entries in the multi-map.

Specified by:

entries in interface MultiMap

Specified by:

entries in class io.netty.handler.codec.http.HttpHeaders

Returns:

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

iterator

public Iterator<Map.Entry<String,String>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,String>>

Specified by:

iterator in class io.netty.handler.codec.http.HttpHeaders

isEmpty

public boolean isEmpty()

Description copied from interface: MultiMap

Return true if empty

Specified by:

isEmpty in interface MultiMap

Specified by:

isEmpty in class io.netty.handler.codec.http.HttpHeaders

names

public Set<String> names()

Description copied from interface: MultiMap

Gets a immutable Set of all names

Specified by:

names in interface MultiMap

Specified by:

names in class io.netty.handler.codec.http.HttpHeaders

Returns:

A Set of all names

clear

public HeadersMultiMap clear()

Description copied from interface: MultiMap

Removes all

Specified by:

clear in interface MultiMap

Specified by:

clear in class io.netty.handler.codec.http.HttpHeaders

Returns:

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

toString

public String toString()

Overrides:

toString in class io.netty.handler.codec.http.HttpHeaders

getInt

public Integer getInt(CharSequence name)

Specified by:

getInt in class io.netty.handler.codec.http.HttpHeaders

getInt

public int getInt(CharSequence name,
                  int defaultValue)

Specified by:

getInt in class io.netty.handler.codec.http.HttpHeaders

getShort

public Short getShort(CharSequence name)

Specified by:

getShort in class io.netty.handler.codec.http.HttpHeaders

getShort

public short getShort(CharSequence name,
                      short defaultValue)

Specified by:

getShort in class io.netty.handler.codec.http.HttpHeaders

getTimeMillis

public Long getTimeMillis(CharSequence name)

Specified by:

getTimeMillis in class io.netty.handler.codec.http.HttpHeaders

getTimeMillis

public long getTimeMillis(CharSequence name,
                          long defaultValue)

Specified by:

getTimeMillis in class io.netty.handler.codec.http.HttpHeaders

iteratorCharSequence

public Iterator<Map.Entry<CharSequence,CharSequence>> iteratorCharSequence()

Specified by:

iteratorCharSequence in class io.netty.handler.codec.http.HttpHeaders

addInt

public io.netty.handler.codec.http.HttpHeaders addInt(CharSequence name,
                                                      int value)

Specified by:

addInt in class io.netty.handler.codec.http.HttpHeaders

addShort

public io.netty.handler.codec.http.HttpHeaders addShort(CharSequence name,
                                                        short value)

Specified by:

addShort in class io.netty.handler.codec.http.HttpHeaders

setInt

public io.netty.handler.codec.http.HttpHeaders setInt(CharSequence name,
                                                      int value)

Specified by:

setInt in class io.netty.handler.codec.http.HttpHeaders

setShort

public io.netty.handler.codec.http.HttpHeaders setShort(CharSequence name,
                                                        short value)

Specified by:

setShort in class io.netty.handler.codec.http.HttpHeaders

encode

public void encode(io.netty.buffer.ByteBuf buf)