com.squareup.square.http

Class Headers

java.lang.Object

com.squareup.square.http.Headers

public class Headers
extends Object

Class for creating and managing HTTP Headers.

Constructor Summary

Constructors

Constructor and Description
Headers() Default constructor
Headers(Headers h) Copy Constructor
Headers(Map<String,List<String>> headers) Constructor that creates a new instance using a given Map

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.
void	addAll(Headers 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.
String	value(String headerName) Returns the first value associated with a given header name, or null if the header name is not found
List<String>	values(String headerName) Returns a List of all values associated with a given header name, or null if the header name is not found

Methods inherited from class java.lang.Object

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

Constructor Detail

Headers

public Headers()

Default constructor

Headers

public Headers(Map<String,List<String>> headers)

Constructor that creates a new instance using a given Map

Parameters:

headers - The Map to use for creating an instance of this class

Headers

public Headers(Headers h)

Copy Constructor

Method Detail

has

public boolean has(String headerName)

Use to check if the given name is present in headers

Parameters:

headerName -

Returns:

true if headerName is found, false otherwise

names

public Set<String> names()

Returns a Set containing all header names

Returns:

A Set containing all header names

value

public String value(String headerName)

Returns 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, or null if the header name is not found

values

public List<String> values(String headerName)

Returns 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, or null if the header name is not found

asSimpleMap

public 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

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

Returns a simulated MultiMap of the headers

Returns:

A Map of header names and values

add

public 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

public 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

public 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

public 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

public void addAll(Headers 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

public List<String> remove(String headerName)

Removes the mapping for a header name if it is present.

Returns 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, or null if the header name is not found