java.lang.Object | |
↳ | com.sun.net.httpserver.Headers |
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 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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
adds the given value to the list of headers
for the given key.
| |||||||||||
Removes all of the mappings from this map (optional operation).
| |||||||||||
Returns true if this map contains a mapping for the specified
key.
| |||||||||||
Returns true if this map maps one or more keys to the
specified value.
| |||||||||||
Returns a
Set view of the mappings contained in this map. | |||||||||||
Indicates whether some other object is "equal to" this one.
| |||||||||||
Returns the value to which the specified key is mapped,
or
null if this map contains no mapping for the key. | |||||||||||
returns the first value from the List of String values
for the given key (if at least one exists).
| |||||||||||
Returns a hash code value for the object.
| |||||||||||
Returns true if this map contains no key-value mappings.
| |||||||||||
Returns a
Set view of the keys contained in this map. | |||||||||||
Removes the mapping for a key from this map if it is present
(optional operation).
| |||||||||||
sets the given value as the sole header value
for the given key.
| |||||||||||
Returns the number of key-value mappings in this map.
| |||||||||||
Returns a
Collection view of the values contained in this map. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
adds the given value to the list of headers for the given key. If the mapping does not already exist, then it is created
key | the header name |
---|---|
value | the header value to add to the header |
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)
key | key whose presence in this map is to be tested |
---|
Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.
value | value whose presence in this map is to be tested |
---|
Returns a Set
view of the mappings contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation, or through the
setValue operation on a map entry returned by the
iterator) the results of the iteration are undefined. The set
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Set.remove, removeAll, retainAll and
clear operations. It does not support the
add or addAll operations.
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y) consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
o | the reference object with which to compare. |
---|
true
if this object is the same as the obj
argument; false
otherwise.Returns the value to which the specified key is mapped,
or null
if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
k
to a value v
such that (key==null ? k==null :
key.equals(k))
, then this method returns v
; otherwise
it returns null
. (There can be at most one such mapping.)
If this map permits null values, then a return value of
null
does not necessarily indicate that the map
contains no mapping for the key; it's also possible that the map
explicitly maps the key to null
. The containsKey
operation may be used to distinguish these two cases.
key | the key whose associated value is to be returned |
---|
null
if this map contains no mapping for the keyreturns the first value from the List of String values for the given key (if at least one exists).
key | the key to search for |
---|
Returns a hash code value for the object. This method is
supported for the benefit of hashtables such as those provided by
java.util.Hashtable
.
The general contract of hashCode
is:
hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
Returns true if this map contains no key-value mappings.
Returns a Set
view of the keys contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.
Removes the mapping for a key from this map if it is present
(optional operation). More formally, if this map contains a mapping
from key k to value v such that
(key==null ? k==null : key.equals(k))
, that mapping
is removed. (The map can contain at most one such mapping.)
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.
The map will not contain a mapping for the specified key once the call returns.
key | key whose mapping is to be removed from the map |
---|
sets the given value as the sole header value for the given key. If the mapping does not already exist, then it is created
key | the header name |
---|---|
value | the header value to set. |
Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
Returns a Collection
view of the values contained in this map.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.