public class Headers extends Object implements Map<String,List<String>>
Map<String, List
<String>>.
The keys are case-insensitive Strings representing the header names and
the value associated with each key is
a List<String> with one
element for each occurrence of the header name in the request or response.
For example, if a response header instance contains one key "HeaderName" with two values "value1 and value2" then this object is output as two header lines:
HeaderName: value1 HeaderName: value2
All the normal Map methods are provided, but the following
additional convenience methods are most likely to be used:
getFirst(String) returns a single valued header or the first value of
a multi-valued header.add(String,String) adds the given header value to the list for the given keyset(String,String) sets the given header field to the single value given
overwriting any existing values in the value list.
All methods in this class accept null values for keys and values. However, null
keys will never will be present in HTTP request headers, and will not be output/sent in response headers.
Null values can be represented as either a null entry for the key (i.e. the list is null) or
where the key has a list, but one (or more) of the list's values is null. Null values are output
as a header line containing the key but no associated value.
| Constructor and Description |
|---|
Headers() |
| Modifier and Type | Method and Description |
|---|---|
void |
add(String key,
String value)
adds the given value to the list of headers
for the given key.
|
void |
clear() |
boolean |
containsKey(Object key) |
boolean |
containsValue(Object value) |
Set<Map.Entry<String,List<String>>> |
entrySet() |
boolean |
equals(Object o) |
List<String> |
get(Object key) |
String |
getFirst(String key)
returns the first value from the List of String values
for the given key (if at least one exists).
|
int |
hashCode() |
boolean |
isEmpty() |
Set<String> |
keySet() |
List<String> |
put(String key,
List<String> value) |
void |
putAll(Map<? extends String,? extends List<String>> t) |
List<String> |
remove(Object key) |
void |
set(String key,
String value)
sets the given value as the sole header value
for the given key.
|
int |
size() |
Collection<List<String>> |
values() |
public boolean containsKey(Object key)
containsKey in interface Map<String,List<String>>public boolean containsValue(Object value)
containsValue in interface Map<String,List<String>>public String getFirst(String key)
key - the key to search forpublic void add(String key, String value)
key - the header namevalue - the header value to add to the headerpublic void set(String key, String value)
key - the header namevalue - the header value to set.public Collection<List<String>> values()
public boolean equals(Object o)
Copyright © 2018. All rights reserved.