Top Fields Constructors Methods
io.vertx.core.http.impl.headers

public Class Http2HeadersAdaptor

extends Object
implements MultiMap
Class Inheritance
All Implemented Interfaces
io.vertx.core.MultiMap, java.lang.Iterable
Imports
io.netty.handler.codec.http.HttpHeaderNames, io.netty.handler.codec.http2.Http2Headers, io.vertx.core.MultiMap, io.vertx.core.http.impl.HttpUtils, java.util.AbstractList, .Iterator, .List, .Map, .Set, .TreeSet, java.util.stream.Collectors

Author
Norman Maurer

Field Summary

Modifier and TypeField and Description
private final Http2Headers

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public MultiMap
add(String
The name
name
,
String
The value being added
value
)

Implements io.vertx.core.MultiMap.add.

Adds a new value with the specified name and value.

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

Implements io.vertx.core.MultiMap.add.

Adds a new values under the specified name

public MultiMap
add(CharSequence name, CharSequence value)

Implements io.vertx.core.MultiMap.add.

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

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

Implements io.vertx.core.MultiMap.add.

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

public MultiMap
addAll(MultiMap headers)

Implements io.vertx.core.MultiMap.addAll.

Adds all the entries from another MultiMap to this one

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

Implements io.vertx.core.MultiMap.addAll.

Adds all the entries from a Map to this

public MultiMap
clear()

Implements io.vertx.core.MultiMap.clear.

Removes all

public boolean
contains(String
The name to search for
name
)

Implements io.vertx.core.MultiMap.contains.

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

public boolean
contains(String
the name to search for
name
,
String
the value to search for
value
,
boolean caseInsensitive)

Overrides default io.vertx.core.MultiMap.contains.

Check if there is a header with the specified name and value.

public boolean
contains(CharSequence name)

Implements io.vertx.core.MultiMap.contains.

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

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

Overrides default io.vertx.core.MultiMap.contains.

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

public String
get(String
The name of the header to search
name
)

Implements io.vertx.core.MultiMap.get.

Returns the value of with the specified name.

public String
public List<String>
getAll(String
The name to search
name
)

Implements io.vertx.core.MultiMap.getAll.

Returns the values with the specified name

public List<String>
getAll(CharSequence name)

Implements io.vertx.core.MultiMap.getAll.

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

public boolean
isEmpty()

Implements io.vertx.core.MultiMap.isEmpty.

Return true if empty

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

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public Set<String>
names()

Implements io.vertx.core.MultiMap.names.

Gets a immutable java.util.Set of all names

public MultiMap
remove(String
The name of the value to remove
name
)

Implements io.vertx.core.MultiMap.remove.

Removes the value with the given name

public MultiMap
remove(CharSequence name)

Implements io.vertx.core.MultiMap.remove.

Like remove(String) but accepting CharSequence as parameters

public MultiMap
set(String
The name
name
,
String
The value
value
)

Implements io.vertx.core.MultiMap.set.

Sets a value under the specified name.

public MultiMap
set(String
The name of the headers being set
name
,
Iterable<String>
The values of the headers being set
values
)

Implements io.vertx.core.MultiMap.set.

Sets values for the specified name.

public MultiMap
set(CharSequence name, CharSequence value)

Implements io.vertx.core.MultiMap.set.

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

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

Implements io.vertx.core.MultiMap.set.

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

public MultiMap
setAll(MultiMap httpHeaders)

Implements io.vertx.core.MultiMap.setAll.

Cleans this instance.

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

Implements io.vertx.core.MultiMap.setAll.

Cleans and set all values of the given instance

public int
size()

Implements io.vertx.core.MultiMap.size.

Return the number of keys.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

headersback to summary
private final Http2Headers headers

Constructor Detail

Http2HeadersAdaptorback to summary
public Http2HeadersAdaptor(Http2Headers headers)

Method Detail

addback to summary
public MultiMap add(String name, String value)

Implements io.vertx.core.MultiMap.add.

Doc from io.vertx.core.MultiMap.add.

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
@Override
addback to summary
public MultiMap add(String name, Iterable<String> values)

Implements io.vertx.core.MultiMap.add.

Doc from io.vertx.core.MultiMap.add.

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
@Override
addback to summary
public MultiMap add(CharSequence name, CharSequence value)

Implements io.vertx.core.MultiMap.add.

Doc from io.vertx.core.MultiMap.add.

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

Annotations
@Override
addback to summary
public MultiMap add(CharSequence name, Iterable<CharSequence> values)

Implements io.vertx.core.MultiMap.add.

Doc from io.vertx.core.MultiMap.add.

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

Annotations
@Override
addAllback to summary
public MultiMap addAll(MultiMap headers)

Implements io.vertx.core.MultiMap.addAll.

Doc from io.vertx.core.MultiMap.addAll.

Adds all the entries from another MultiMap to this one

Returns:MultiMap

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

Annotations
@Override
addAllback to summary
public MultiMap addAll(Map<String, String> map)

Implements io.vertx.core.MultiMap.addAll.

Doc from io.vertx.core.MultiMap.addAll.

Adds all the entries from a Map to this

Returns:MultiMap

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

Annotations
@Override
clearback to summary
public MultiMap clear()

Implements io.vertx.core.MultiMap.clear.

Doc from io.vertx.core.MultiMap.clear.

Removes all

Returns:MultiMap

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

Annotations
@Override
containsback to summary
public boolean contains(String name)

Implements io.vertx.core.MultiMap.contains.

Doc from io.vertx.core.MultiMap.contains.

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

Annotations
@Override
containsback to summary
public boolean contains(String name, String value, boolean caseInsensitive)

Overrides default io.vertx.core.MultiMap.contains.

Doc from io.vertx.core.MultiMap.contains.

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

Annotations
@Override
containsback to summary
public boolean contains(CharSequence name)

Implements io.vertx.core.MultiMap.contains.

Doc from io.vertx.core.MultiMap.contains.

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

Annotations
@Override
containsback to summary
public boolean contains(CharSequence name, CharSequence value, boolean caseInsensitive)

Overrides default io.vertx.core.MultiMap.contains.

Doc from io.vertx.core.MultiMap.contains.

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

Annotations
@Override
getback to summary
public String get(String name)

Implements io.vertx.core.MultiMap.get.

Doc from io.vertx.core.MultiMap.get.

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:String

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

Annotations
@Override
getback to summary
public String get(CharSequence name)

Implements io.vertx.core.MultiMap.get.

Annotations
@Override
getAllback to summary
public List<String> getAll(String name)

Implements io.vertx.core.MultiMap.getAll.

Doc from io.vertx.core.MultiMap.getAll.

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

Annotations
@Override
getAllback to summary
public List<String> getAll(CharSequence name)

Implements io.vertx.core.MultiMap.getAll.

Doc from io.vertx.core.MultiMap.getAll.

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

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Implements io.vertx.core.MultiMap.isEmpty.

Doc from io.vertx.core.MultiMap.isEmpty.

Return true if empty

Annotations
@Override
iteratorback to summary
public Iterator<Map.Entry<String, String>> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

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

an Iterator.

Annotations
@Override
namesback to summary
public Set<String> names()

Implements io.vertx.core.MultiMap.names.

Doc from io.vertx.core.MultiMap.names.

Gets a immutable java.util.Set of all names

Returns:Set<String>

A java.util.Set of all names

Annotations
@Override
removeback to summary
public MultiMap remove(String name)

Implements io.vertx.core.MultiMap.remove.

Doc from io.vertx.core.MultiMap.remove.

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
@Override
removeback to summary
public MultiMap remove(CharSequence name)

Implements io.vertx.core.MultiMap.remove.

Doc from io.vertx.core.MultiMap.remove.

Like remove(String) but accepting CharSequence as parameters

Annotations
@Override
setback to summary
public MultiMap set(String name, String value)

Implements io.vertx.core.MultiMap.set.

Doc from io.vertx.core.MultiMap.set.

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
@Override
setback to summary
public MultiMap set(String name, Iterable<String> values)

Implements io.vertx.core.MultiMap.set.

Doc from io.vertx.core.MultiMap.set.

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
@Override
setback to summary
public MultiMap set(CharSequence name, CharSequence value)

Implements io.vertx.core.MultiMap.set.

Doc from io.vertx.core.MultiMap.set.

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

Annotations
@Override
setback to summary
public MultiMap set(CharSequence name, Iterable<CharSequence> values)

Implements io.vertx.core.MultiMap.set.

Doc from io.vertx.core.MultiMap.set.

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

Annotations
@Override
setAllback to summary
public MultiMap setAll(MultiMap httpHeaders)

Implements io.vertx.core.MultiMap.setAll.

Doc from io.vertx.core.MultiMap.setAll.

Cleans this instance.

Returns:MultiMap

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

Annotations
@Override
setAllback to summary
public MultiMap setAll(Map<String, String> headers)

Implements io.vertx.core.MultiMap.setAll.

Doc from io.vertx.core.MultiMap.setAll.

Cleans and set all values of the given instance

Returns:MultiMap

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

Annotations
@Override
sizeback to summary
public int size()

Implements io.vertx.core.MultiMap.size.

Doc from io.vertx.core.MultiMap.size.

Return the number of keys.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override