org.apache.commons.httpclient

Class Header

Implemented Interfaces:
Serializable

public class Header
extends NameValuePair

An HTTP header.
Version:
$Revision: 155418 $ $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
Authors:
Remy Maucherat
Mike Bowler
Oleg Kalnichevski

Constructor Summary

Header()
Default constructor.
Header(String name, String value)
Constructor with name and value
Header(String name, String value, boolean isAutogenerated)
Constructor with name and value

Method Summary

HeaderElement[]
getElements()
Returns an array of HeaderElements constructed from my value.
HeaderElement[]
getValues()
Deprecated. Use #getElements
boolean
isAutogenerated()
Returns the value of the auto-generated header flag.
String
toExternalForm()
Returns a String representation of the header.
String
toString()
Returns a String representation of the header.

Methods inherited from class org.apache.commons.httpclient.NameValuePair

equals, getName, getValue, hashCode, setName, setValue, toString

Constructor Details

Header

public Header()
Default constructor.

Header

public Header(String name,
              String value)
Constructor with name and value
Parameters:
name - the header name
value - the header value

Header

public Header(String name,
              String value,
              boolean isAutogenerated)
Constructor with name and value
Parameters:
name - the header name
value - the header value
isAutogenerated - true if the header is autogenerated, false otherwise.
Since:
3.0

Method Details

getElements

public HeaderElement[] getElements()
Returns an array of HeaderElements constructed from my value.
Returns:
an array of header elements
Since:
3.0

getValues

public HeaderElement[] getValues()
            throws HttpException

Deprecated. Use #getElements

Returns an array of HeaderElements constructed from my value.
Returns:
an array of header elements
Throws:
HttpException - if the header cannot be parsed

isAutogenerated

public boolean isAutogenerated()
Returns the value of the auto-generated header flag.
Returns:
true if the header is autogenerated, false otherwise.
Since:
3.0

toExternalForm

public String toExternalForm()
Returns a String representation of the header.
Returns:
stringHEAD

toString

public String toString()
Returns a String representation of the header.
Overrides:
toString in interface NameValuePair
Returns:
stringHEAD

Copyright (c) 1999-2005 - Apache Software Foundation