Package io.gravitee.gateway.api.http

Interface HttpHeaders

All Superinterfaces:

Iterable<Map.Entry<String,String>>

All Known Implementing Classes:

DefaultHttpHeaders

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

Author:

David BRASSELY (david.brassely at graviteesource.com), GraviteeSource Team

Method Summary

Modifier and Type	Method	Description
HttpHeaders	add(CharSequence name, CharSequence value)
HttpHeaders	add(CharSequence name, Iterable<CharSequence> values)
void	clear()
boolean	contains(CharSequence name)
default boolean	contains(String name)
default boolean	containsAllKeys(Collection<String> names)
default boolean	containsKey(CharSequence name)	Deprecated.
default boolean	containsKey(String name)
static HttpHeaders	create()
static HttpHeaders	create(HttpHeaders headers)
default boolean	deeplyEquals(HttpHeaders other)	Indicates if this instance of HttpHeaders is deeply equal to another one.
String	get(CharSequence name)
List<String>	getAll(CharSequence name)
default String	getFirst(CharSequence name)	Deprecated.
default List<String>	getOrDefault(CharSequence key, List<String> defaultValue)
boolean	isEmpty()
Set<String>	names()
HttpHeaders	remove(CharSequence name)
HttpHeaders	set(CharSequence name, CharSequence value)
HttpHeaders	set(CharSequence name, Iterable<CharSequence> values)
int	size()
default Map<String,List<String>>	toListValuesMap()
default Map<String,String>	toSingleValueMap()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

create

static HttpHeaders create()

create

static HttpHeaders create(HttpHeaders headers)

getFirst

default String getFirst(CharSequence name)

Deprecated.

Ensure backward compatibility, should be removed in the future

get

String get(CharSequence name)

getAll

List<String> getAll(CharSequence name)

containsKey

default boolean containsKey(CharSequence name)

Deprecated.

Ensure backward compatibility, should be removed in the future

containsKey

default boolean containsKey(String name)

contains

boolean contains(CharSequence name)

contains

default boolean contains(String name)

names

Set<String> names()

add

HttpHeaders add(CharSequence name,
 CharSequence value)

add

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

set

HttpHeaders set(CharSequence name,
 CharSequence value)

set

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

remove

HttpHeaders remove(CharSequence name)

clear

void clear()

size

int size()

isEmpty

boolean isEmpty()

getOrDefault

default List<String> getOrDefault(CharSequence key,
 List<String> defaultValue)

toSingleValueMap

default Map<String,String> toSingleValueMap()

toListValuesMap

default Map<String,List<String>> toListValuesMap()

containsAllKeys

default boolean containsAllKeys(Collection<String> names)

deeplyEquals

default boolean deeplyEquals(HttpHeaders other)

Indicates if this instance of HttpHeaders is deeply equal to another one. Comparison is made on size equality, key-set equality, then on equality of collection of values for each key.

Parameters:

other - the other HttpHeaders instance to compare with this one

Returns:

true if instance are deeply equal, else returns false