public class Headers extends TreeMap<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 the request has the the following headers:
Then get("hEaDeRnAmE") would give both "value1", and "value2" values in a listHeaderName: 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.
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
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.
|
String |
getFirst(String key)
Returns the first value from the List of String values for the given key
(if at least one exists).
|
void |
set(String key,
String value)
Sets the given value as the sole header value for the given key.
|
ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values
equals, hashCode, isEmpty, toString
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove
public void add(String key, String value)
key
- the header namevalue
- the header value to add to the headerpublic String getFirst(String key)
key
- the key to search forCopyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.