com.azure.core.http

Class HttpHeaders

java.lang.Object

com.azure.core.http.HttpHeaders

All Implemented Interfaces:

com.fasterxml.jackson.databind.JsonSerializable, Iterable<HttpHeader>

public class HttpHeaders
extends Object
implements Iterable<HttpHeader>, com.fasterxml.jackson.databind.JsonSerializable

A collection of headers on an HTTP request or response.

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

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) Get the header for the provided header name.
Iterator<HttpHeader>	iterator()
HttpHeaders	put(String name, String value) Set a header.
void	serialize(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
void	serializeWithType(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider, com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSerializer)
int	size() Gets the number of headers in the collection.
Map<String,String>	toMap() Get Map representation of the HttpHeaders collection.
String	value(String name) Get the header value for the provided header name.
String[]	values(String name) Get the header values for the provided header name.

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

size

public int size()

Gets the number of headers in the collection.

Returns:

the number of headers in this collection.

put

public HttpHeaders put(String name,
                       String value)

Set a header. 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)

Get the header for the provided header name. Null will be returned if the header isn't found.

Parameters:

name - the name of the header to find.

Returns:

the header if found, null otherwise.

value

public String value(String name)

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

Parameters:

name - the name of the header to look for

Returns:

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

values

public String[] values(String name)

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

Parameters:

name - the name of the header to look for

Returns:

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

toMap

public Map<String,String> toMap()

Get Map representation of the HttpHeaders collection.

Returns:

the headers as map

iterator

public Iterator<HttpHeader> iterator()

Specified by:

iterator in interface Iterable<HttpHeader>

serialize

public void serialize(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                      com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
               throws IOException

Specified by:

serialize in interface com.fasterxml.jackson.databind.JsonSerializable

Throws:

IOException

serializeWithType

public void serializeWithType(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                              com.fasterxml.jackson.databind.SerializerProvider serializerProvider,
                              com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSerializer)
                       throws IOException

Specified by:

serializeWithType in interface com.fasterxml.jackson.databind.JsonSerializable

Throws:

IOException