com.microsoft.rest.v2.http

Class HttpHeaders

java.lang.Object

com.microsoft.rest.v2.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 object.
HttpHeaders(Iterable<HttpHeader> headers) Create a HttpHeaders object with the provided initial headers.
HttpHeaders(Map<String,String> headers) Create a HttpHeaders object with the provided initial headers.

Method Summary

Modifier and Type	Method and Description
Iterator<HttpHeader>	iterator()
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)
HttpHeaders	set(String headerName, String headerValue) Set the value for the header named headerName, discarding any value previously added for that header.
int	size() Get the number of HTTP headers in this collection.
Map<String,String>	toMap() Convert this HttpHeaders collection to a Map.
String	value(String headerName) Get the header value for the provided header name.
String[]	values(String headerName) 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 object.

HttpHeaders

public HttpHeaders(Map<String,String> headers)

Create a HttpHeaders object with the provided initial headers.

Parameters:

headers - The map of name to value associations to use as initial headers.

HttpHeaders

public HttpHeaders(Iterable<HttpHeader> headers)

Create a HttpHeaders object with the provided initial headers.

Parameters:

headers - The map of name to value associations to use as initial headers.

Method Detail

size

public int size()

Get the number of HTTP headers in this collection.

Returns:

The number of HTTP headers in this collection.

set

public HttpHeaders set(String headerName,
                       String headerValue)

Set the value for the header named headerName, discarding any value previously added for that header.

Parameters:

headerName - The name of the header.

headerValue - The value of the header.

Returns:

This HttpHeaders instance.

value

public String value(String headerName)

Get the header value for the provided header name. If the header name isn't found, then null will be returned.

Parameters:

headerName - 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 headerName)

Get the header values for the provided header name. If the header name isn't found, then null will be returned.

Parameters:

headerName - The name of the header to look for.

Returns:

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

toMap

public Map<String,String> toMap()

Convert this HttpHeaders collection to a Map.

Returns:

The Map representation of this HttpHeaders collection.

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