io.apimatic.coreinterfaces.http

Interface HttpHeaders

public interface HttpHeaders

For creating and managing HTTP Headers.

Method Summary

Modifier and Type	Method and Description
void	add(String headerName, List<String> values) Adds a List of values for a header name to this object.
void	add(String headerName, String value) Adds a value for a header name to this object, neither headerName nor value can be null.
void	addAll(HttpHeaders headers) Adds all the entries in a Headers object to this object.
void	addAllFromMap(Map<String,String> headers) Adds values from a Map to this object.
void	addAllFromMultiMap(Map<String,List<String>> headers) Adds values from a simulated Multi-Map to this object.
Map<String,List<String>>	asMultimap() Returns a simulated MultiMap of the headers.
Map<String,String>	asSimpleMap() Returns a Map of the headers, giving only one value for each header name.
boolean	has(String headerName) Use to check if the given name is present in headers.
Set<String>	names() Returns a Set containing all header names.
List<String>	remove(String headerName) Removes the mapping for a header name if it is present, and get the value to which this map previously associated the key, or null if the map contained no mapping for the key.
String	value(String headerName) Get the first value associated with a given header name, or null if the header name is not found.
List<String>	values(String headerName) Get a List of all values associated with a given header name, or null if the header name is not found.

Method Detail

has

boolean has(String headerName)

Use to check if the given name is present in headers.

Parameters:

headerName - String name for header to be checked.

Returns:

true if headerName is found, false otherwise.

names

Set<String> names()

Returns a Set containing all header names.

Returns:

A Set containing all header names.

value

String value(String headerName)

Get the first value associated with a given header name, or null if the header name is not found.

Parameters:

headerName - The header name to find the associated value for.

Returns:

The first value associated with the given header name.

values

List<String> values(String headerName)

Get a List of all values associated with a given header name, or null if the header name is not found.

Parameters:

headerName - The header name to find the associated values for.

Returns:

A List of values associated with the given header name.

asSimpleMap

Map<String,String> asSimpleMap()

Returns a Map of the headers, giving only one value for each header name.

Returns:

A Map of header names and values.

asMultimap

Map<String,List<String>> asMultimap()

Returns a simulated MultiMap of the headers.

Returns:

A Map of header names and values.

add

void add(String headerName,
         String value)

Adds a value for a header name to this object, neither headerName nor value can be null.

Parameters:

headerName - The header name to add the value against.

value - The value to add.

add

void add(String headerName,
         List<String> values)

Adds a List of values for a header name to this object. neither headerName nor values can be null.

Parameters:

headerName - The header name to add the values against.

values - The List of values to add.

addAllFromMap

void addAllFromMap(Map<String,String> headers)

Adds values from a Map to this object.

Parameters:

headers - A Map containing header names and values as Entry pairs.

addAllFromMultiMap

void addAllFromMultiMap(Map<String,List<String>> headers)

Adds values from a simulated Multi-Map to this object.

Parameters:

headers - A Map containing header names and values as Entry pairs.

addAll

void addAll(HttpHeaders headers)

Adds all the entries in a Headers object to this object.

Parameters:

headers - The object whose values are to be added to this object.

remove

List<String> remove(String headerName)

Removes the mapping for a header name if it is present, and get the value to which this map previously associated the key, or null if the map contained no mapping for the key.

Parameters:

headerName - The header name to remove the associated values for

Returns:

A List of values associated with the given header name.