com.sun.xml.ws.transport
Class Headers
java.lang.Object
com.sun.xml.ws.transport.Headers
- All Implemented Interfaces:
- Map<String,List<String>>
public class Headers
- extends Object
- implements Map<String,List<String>>
HTTP request and response headers are represented by this class which implements
the interface 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 occurence 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 key
set(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.
- Since:
- 1.6
Nested classes/interfaces inherited from interface java.util.Map |
Map.Entry<K,V> |
map
HashMap<String,List<String>> map
Headers
public Headers()
size
public int size()
- Specified by:
size
in interface Map<String,List<String>>
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interface Map<String,List<String>>
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interface Map<String,List<String>>
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interface Map<String,List<String>>
get
public List<String> get(Object key)
- Specified by:
get
in interface Map<String,List<String>>
getFirst
public String getFirst(String key)
- returns the first value from the List of String values
for the given key (if at least one exists).
- Parameters:
key
- the key to search for
- Returns:
- the first string value associated with the key
put
public List<String> put(String key,
List<String> value)
- Specified by:
put
in interface Map<String,List<String>>
add
public void add(String key,
String value)
- adds the given value to the list of headers
for the given key. If the mapping does not
already exist, then it is created
- Parameters:
key
- the header namevalue
- the header value to add to the header
set
public void set(String key,
String value)
- sets the given value as the sole header value
for the given key. If the mapping does not
already exist, then it is created
- Parameters:
key
- the header namevalue
- the header value to set.
remove
public List<String> remove(Object key)
- Specified by:
remove
in interface Map<String,List<String>>
putAll
public void putAll(Map<? extends String,? extends List<String>> t)
- Specified by:
putAll
in interface Map<String,List<String>>
clear
public void clear()
- Specified by:
clear
in interface Map<String,List<String>>
keySet
public Set<String> keySet()
- Specified by:
keySet
in interface Map<String,List<String>>
values
public Collection<List<String>> values()
- Specified by:
values
in interface Map<String,List<String>>
entrySet
public Set<Map.Entry<String,List<String>>> entrySet()
- Specified by:
entrySet
in interface Map<String,List<String>>
equals
public boolean equals(Object o)
- Specified by:
equals
in interface Map<String,List<String>>
- Overrides:
equals
in class Object
hashCode
public int hashCode()
- Specified by:
hashCode
in interface Map<String,List<String>>
- Overrides:
hashCode
in class Object
toString
public String toString()
- Overrides:
toString
in class Object