public interface

HeaderElement

org.apache.http.HeaderElement
Known Indirect Subclasses

Class Overview

One element of an HTTP header value consisting of a name / value pair and a number of optional name / value parameters.

Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. Such headers must be in the following form:

 header  = [ element ] *( "," [ element ] )
 element = name [ "=" [ value ] ] *( ";" [ param ] )
 param   = name [ "=" [ value ] ]

 name    = token
 value   = ( token | quoted-string )

 token         = 1*<any char except "=", ",", ";", <"> and
                       white space>
 quoted-string = <"> *( text | quoted-char ) <">
 text          = any char except <">
 quoted-char   = "\" char
 

Any amount of white space is allowed between any part of the header, element or param and is ignored. A missing value in any element or param will be stored as the empty String; if the "=" is also missing null will be stored instead.

Summary

Public Methods
abstract String getName()
Returns header element name.
abstract NameValuePair getParameter(int index)
Returns parameter with the given index.
abstract NameValuePair getParameterByName(String name)
Returns the first parameter with the given name.
abstract int getParameterCount()
Returns the total count of parameters.
abstract NameValuePair[] getParameters()
Returns an array of name / value pairs.
abstract String getValue()
Returns header element value.

Public Methods

public abstract String getName ()

Returns header element name.

Returns
  • header element name

public abstract NameValuePair getParameter (int index)

Returns parameter with the given index.

Returns
  • name / value pair

public abstract NameValuePair getParameterByName (String name)

Returns the first parameter with the given name.

Parameters
name parameter name
Returns
  • name / value pair

public abstract int getParameterCount ()

Returns the total count of parameters.

Returns
  • parameter count

public abstract NameValuePair[] getParameters ()

Returns an array of name / value pairs.

Returns
  • array of name / value pairs

public abstract String getValue ()

Returns header element value.

Returns
  • header element value