org.apache.commons.httpclient
Class HeaderGroup
java.lang.Object
org.apache.commons.httpclient.HeaderGroup
public class HeaderGroup
extends java.lang.Object
A class for combining a set of headers. This class allows for multiple
headers with the same name and keeps track of the order in which headers were
added.
HeaderGroup
public HeaderGroup()
Constructor for HeaderGroup.
addHeader
public void addHeader(Header header)
Adds the given header to the group. The order in which this header was
added is preserved.
header
- the header to add
clear
public void clear()
Removes any contained headers.
containsHeader
public boolean containsHeader(String name)
Tests if headers with the given name are contained within this group.
Header name comparison is case insensitive.
name
- the header name to test for
true
if at least one header with the name is
contained, false
otherwise
getAllHeaders
public Header[] getAllHeaders()
Gets all of the headers contained within this group.
getCondensedHeader
public Header getCondensedHeader(String name)
Gets a header representing all of the header values with the given name.
If more that one header with the given name exists the values will be
combined with a "," as per RFC 2616.
Header name comparison is case insensitive.
name
- the name of the header(s) to get
- a header with a condensed value or
null
if no
headers by the given name are present
getFirstHeader
public Header getFirstHeader(String name)
Gets the first header with the given name.
Header name comparison is case insensitive.
name
- the name of the header to get
getHeaders
public Header[] getHeaders(String name)
Gets all of the headers with the given name. The returned array
maintains the relative order in which the headers were added.
Header name comparison is case insensitive.
name
- the name of the header(s) to get
getIterator
public Iterator getIterator()
Returns an iterator over this group of headers.
- iterator over this group of headers.
getLastHeader
public Header getLastHeader(String name)
Gets the last header with the given name.
Header name comparison is case insensitive.
name
- the name of the header to get
removeHeader
public void removeHeader(Header header)
Removes the given header.
header
- the header to remove
setHeaders
public void setHeaders(Header[] headers)
Sets all of the headers contained within this group overriding any
existing headers. The headers are added in the order in which they appear
in the array.
headers
- the headers to set
Copyright (c) 1999-2005 - Apache Software Foundation