com.azure.core.http

Class HttpHeaders

java.lang.Object

com.azure.core.http.HttpHeaders

All Implemented Interfaces:

Iterable<HttpHeader>

public class HttpHeaders
extends Object
implements Iterable<HttpHeader>

A collection of headers on an HTTP request or response.

Constructor Summary

Constructors

Constructor and Description
HttpHeaders() Create an empty HttpHeaders instance.
HttpHeaders(Iterable<HttpHeader> headers) Create a HttpHeaders instance with the provided initial headers.
HttpHeaders(Map<String,String> headers) Create a HttpHeaders instance with the provided initial headers.

Method Summary

Modifier and Type	Method and Description
HttpHeader	get(String name) Gets the header for the provided header name.
int	getSize() Gets the number of headers in the collection.
String	getValue(String name) Get the value for the provided header name.
String[]	getValues(String name) Get the values for the provided header name.
Iterator<HttpHeader>	iterator()
HttpHeaders	put(String name, String value) Sets a header with the given name and value.
HttpHeader	remove(String name) Removes the header with the provided header name.
Stream<HttpHeader>	stream() Get a Stream representation of the HttpHeader values in this instance.
Map<String,String>	toMap() Gets a Map representation of the HttpHeaders collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HttpHeaders

public HttpHeaders()

Create an empty HttpHeaders instance.

HttpHeaders

public HttpHeaders(Map<String,String> headers)

Create a HttpHeaders instance with the provided initial headers.

Parameters:

headers - the map of initial headers

HttpHeaders

public HttpHeaders(Iterable<HttpHeader> headers)

Create a HttpHeaders instance with the provided initial headers.

Parameters:

headers - the collection of initial headers

Method Detail

getSize

public int getSize()

Gets the number of headers in the collection.

Returns:

the number of headers in this collection.

put

public HttpHeaders put(String name,
                       String value)

Sets a header with the given name and value.

If header with same name already exists then the value will be overwritten.

Parameters:

name - the name

value - the value

Returns:

The updated HttpHeaders object

get

public HttpHeader get(String name)

Gets the header for the provided header name. Null is returned if the header isn't found.

Parameters:

name - the name of the header to find.

Returns:

the header if found, null otherwise.

remove

public HttpHeader remove(String name)

Removes the header with the provided header name. Null is returned if the header isn't found.

Parameters:

name - the name of the header to remove.

Returns:

the header if removed, null otherwise.

getValue

public String getValue(String name)

Get the value for the provided header name. Null is returned if the header name isn't found.

Parameters:

name - the name of the header whose value is being retrieved.

Returns:

the value of the header, or null if the header isn't found

getValues

public String[] getValues(String name)

Get the values for the provided header name. Null is returned if the header name isn't found.

This returns getValue split by comma.

Parameters:

name - the name of the header whose value is being retrieved.

Returns:

the values of the header, or null if the header isn't found

toMap

public Map<String,String> toMap()

Gets a Map representation of the HttpHeaders collection.

Returns:

the headers as map

iterator

public Iterator<HttpHeader> iterator()

Specified by:

iterator in interface Iterable<HttpHeader>

stream

public Stream<HttpHeader> stream()

Get a Stream representation of the HttpHeader values in this instance.

Returns:

A Stream of all header values in this instance.